Package com.axemble.vdoc.sdk.impl
Class ProcessResource
java.lang.Object
com.axemble.vdoc.sdk.impl.AbstractElement
com.axemble.vdoc.sdk.impl.ProcessElement
com.axemble.vdoc.sdk.impl.ProcessResource
- All Implemented Interfaces:
IElement,IResource,SDKWrapper,IDeletionSupport,IProtocolSupport,ISearchSupport,ISecuritySupport,com.axemble.vdp.resource.interfaces.InternalResource,Serializable
- Direct Known Subclasses:
ProcessLinkedResource,ProcessStorageResource,ProcessWorkflowInstance
public class ProcessResource
extends ProcessElement
implements com.axemble.vdp.resource.interfaces.InternalResource, SDKWrapper
- Author:
- vlygeros
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected com.axemble.vdp.ui.core.document.CoreDocumentFields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement
module -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedProcessResource(IModule module) protectedProcessResource(IModule module, com.axemble.vdp.ui.core.document.CoreDocument document) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddLinkedResource(ILinkedResource linkedResource) Allows to add a linked resource.booleanaddLinkedResources(Collection<? extends ILinkedResource> linkedResources) Allows to add linked resources.voidAllows events to be thrown.createLinkedResource(String propertyName) Creates a linked resource within a property.voidDeletes theIElementobject.voiddeleteLinkedResource(ILinkedResource linkedResource) Allows to remove a linked resource.voiddeleteLinkedResources(Collection<? extends ILinkedResource> linkedResources) Allows to remove a collection of linked resources.voidPrevents from throwing events.booleanChecks if a property exists.Gets the creator of the resource.Gets the created date.Gets the definition of the resourcecom.axemble.vdp.ui.core.document.CoreDocumentcom.axemble.vdoc.core.utils.IntrospectionObjectGets the history of the resourcegetId()Gets the identifier object.Collection<? extends ILinkedResource> getLinkedResources(String propertyName) Retrieves all the linked resources of a property.Collection<? extends IOptionList.IOption> Gets the available values of a list property.Gets the last user who modified the resource.Gets the modified date.getName()Gets the name of a resource.com.axemble.vdoc.core.domain.BaseDomainGets the native object underneath.Gets the value of a property.com.axemble.vdoc.core.utils.IntrospectionObjectvoidrefresh()Refresh all children values cachevoidRefresh children cache for given propertybooleansave()Saves the resource.booleanSaves or updates the element.booleanSaves a specified property.booleanvoidsetCreatedBy(IUser user) Sets the creator of the resource.voidsetCreatedDate(Date date) Sets the created date.voidsetList(String propertyName, Collection<? extends IOptionList.IOption> values) Sets the available values for a list property.voidsetModifiedBy(IUser user) Sets last user who modified the resource.voidsetModifiedDate(Date date) Sets the modified date.voidSets a value to a propertyvoidsetValueNoEvents(String propertyName, Object value) Sets a value to a property without throwing any event.Methods inherited from class com.axemble.vdoc.sdk.impl.ProcessElement
getPath, getProtocolURI, getProtocolURI, getWorkflowModuleMethods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement
getModuleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport
getProtocolURI, getProtocolURI
-
Field Details
-
document
protected com.axemble.vdp.ui.core.document.CoreDocument document
-
-
Constructor Details
-
ProcessResource
-
ProcessResource
-
-
Method Details
-
getId
Description copied from interface:IElementGets the identifier object.- Specified by:
getIdin interfaceIElement- Overrides:
getIdin classProcessElement- Returns:
- a
IStorageKeyobject.
-
getNativeObject
Description copied from interface:IElementGets the native object underneath.- Specified by:
getNativeObjectin interfaceIElement- Returns:
- an object.
-
getNativeDomain
public com.axemble.vdoc.core.domain.BaseDomain getNativeDomain()- Specified by:
getNativeDomainin interfaceSDKWrapper
-
getDocument
public com.axemble.vdp.ui.core.document.CoreDocument getDocument() -
getCreatedDate
Description copied from interface:IResourceGets the created date.- Specified by:
getCreatedDatein interfaceIResource- Returns:
- a
Dateobject.
-
setCreatedDate
Description copied from interface:IResourceSets the created date.- Specified by:
setCreatedDatein interfaceIResource- Parameters:
date- TheDateto set.
-
getModifiedDate
Description copied from interface:IResourceGets the modified date.- Specified by:
getModifiedDatein interfaceIResource- Returns:
- a
Dateobject.
-
setModifiedDate
Description copied from interface:IResourceSets the modified date.- Specified by:
setModifiedDatein interfaceIResource- Parameters:
date- TheDateto set.
-
setCreatedBy
Description copied from interface:IResourceSets the creator of the resource. Can only be set if the resource has not been created yet- Specified by:
setCreatedByin interfaceIResource- Parameters:
user- The creatorIUserof the resource.
-
getCreatedBy
Description copied from interface:IResourceGets the creator of the resource.- Specified by:
getCreatedByin interfaceIResource- Returns:
- a
IUserobject.
-
setModifiedBy
Description copied from interface:IResourceSets last user who modified the resource.- Specified by:
setModifiedByin interfaceIResource- Parameters:
user- The lastIUserwho modified the resource.
-
getModifiedBy
Description copied from interface:IResourceGets the last user who modified the resource.- Specified by:
getModifiedByin interfaceIResource- Returns:
- a
IUserobject.
-
getName
Description copied from interface:IResourceGets the name of a resource. -
exists
Description copied from interface:IResourceChecks if a property exists. -
setValueNoEvents
Description copied from interface:IResourceSets a value to a property without throwing any event.- Specified by:
setValueNoEventsin interfaceIResource- Parameters:
propertyName- The system name of the property.value- The value object to set.
-
setValue
Description copied from interface:IResourceSets a value to a property -
getValue
Description copied from interface:IResourceGets the value of a property. -
setList
Description copied from interface:IResourceSets the available values for a list property.- Specified by:
setListin interfaceIResource- Parameters:
propertyName- The system name of the property.values- A java.util.Collection ofIOptionList.IOptionobjects..
-
getList
Description copied from interface:IResourceGets the available values of a list property.- Specified by:
getListin interfaceIResource- Parameters:
propertyName- The system name of the property.- Returns:
- A java.util.Collection of
IOptionList.IOption.
-
getDefinition
Description copied from interface:IResourceGets the definition of the resource- Specified by:
getDefinitionin interfaceIResource- Returns:
- A
IResourceDefinitionobject.
-
getCatalog
-
createLinkedResource
Description copied from interface:IResourceCreates a linked resource within a property.- Specified by:
createLinkedResourcein interfaceIResource- Parameters:
propertyName- The system name of the property.- Returns:
- a
ILinkedResourceobject.
-
addLinkedResource
Description copied from interface:IResourceAllows to add a linked resource.- Specified by:
addLinkedResourcein interfaceIResource- Parameters:
linkedResource- TheILinkedResourceto add.- Returns:
- true if succeed,
} otherwise.
invalid @link
{@link false
-
addLinkedResources
Description copied from interface:IResourceAllows to add linked resources.- Specified by:
addLinkedResourcesin interfaceIResource- Parameters:
linkedResources- The collection ofILinkedResourceobjects to add.- Returns:
- true if succeed,
} otherwise.
invalid @link
{@link false
-
getLinkedResources
Description copied from interface:IResourceRetrieves all the linked resources of a property.- Specified by:
getLinkedResourcesin interfaceIResource- Parameters:
propertyName- The system name of the property.- Returns:
- A java.util.Collection of
ILinkedResourceobjects.
-
deleteLinkedResource
Description copied from interface:IResourceAllows to remove a linked resource.- Specified by:
deleteLinkedResourcein interfaceIResource- Parameters:
linkedResource- TheILinkedResourceto remove.
-
deleteLinkedResources
Description copied from interface:IResourceAllows to remove a collection of linked resources.- Specified by:
deleteLinkedResourcesin interfaceIResource- Parameters:
linkedResources- The collection ofILinkedResourceobjects.
-
getHistory
Description copied from interface:IResourceGets the history of the resource- Specified by:
getHistoryin interfaceIResource- Returns:
- a
IResourceHistoryobject.
-
save
Description copied from interface:IElementSaves or updates the element.- Specified by:
savein interfaceIElement- Overrides:
savein classProcessElement- Parameters:
context- The Execution context.- Returns:
- return true if succeeded, false otherwise.
-
save
public boolean save()Description copied from interface:IResourceSaves the resource. -
save
Description copied from interface:IResourceSaves a specified property. -
saveNoEvents
public boolean saveNoEvents()- Specified by:
saveNoEventsin interfacecom.axemble.vdp.resource.interfaces.InternalResource
-
delete
Description copied from interface:IDeletionSupportDeletes theIElementobject.- Specified by:
deletein interfaceIDeletionSupport- Parameters:
context- The Execution context.
-
allowEvents
public void allowEvents()Description copied from interface:IResourceAllows events to be thrown.- Specified by:
allowEventsin interfaceIResource
-
denyEvents
public void denyEvents()Description copied from interface:IResourcePrevents from throwing events.- Specified by:
denyEventsin interfaceIResource
-
refresh
public void refresh()Description copied from interface:IResourceRefresh all children values cache -
refresh
Description copied from interface:IResourceRefresh children cache for given property -
getText
-
getValues
public com.axemble.vdoc.core.utils.IntrospectionObject getValues()- Specified by:
getValuesin interfacecom.axemble.vdp.resource.interfaces.InternalResource
-
getFields
public com.axemble.vdoc.core.utils.IntrospectionObject getFields()- Specified by:
getFieldsin interfacecom.axemble.vdp.resource.interfaces.InternalResource
-