Package com.axemble.vdoc.sdk.impl
Class GenericResource
java.lang.Object
com.axemble.vdoc.sdk.impl.AbstractElement
com.axemble.vdoc.sdk.impl.ProcessElement
com.axemble.vdoc.sdk.impl.GenericResource
- All Implemented Interfaces:
- IElement,- ILinkedResource,- IResource,- IDeletionSupport,- IProtocolSupport,- ISearchSupport,- ISecuritySupport,- Serializable
- Author:
- vlygeros
- See Also:
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected IUserprotected Dateprotected com.axemble.vdp.ui.core.document.GenericDocumentstatic final com.axemble.vdp.utils.Loggerprotected IUserprotected DateFields inherited from class com.axemble.vdoc.sdk.impl.AbstractElementmodule
- 
Constructor SummaryConstructorsConstructorDescriptionGenericResource(IModule module, com.axemble.vdp.ui.core.document.GenericDocument document) 
- 
Method SummaryModifier and TypeMethodDescriptionbooleanaddLinkedResource(ILinkedResource linkedResource) Allows to add a linked resource.booleanaddLinkedResources(Collection 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 linkedResources) Allows to remove a collection of linked resources.voidPrevents from throwing events.booleanChecks if a property exists.voidGets the catalog of the linked resourceGets the creator of the resource.Gets the created date.Gets the definition of the resourcecom.axemble.vdp.ui.core.document.GenericDocumentGets the history of the resourcegetLinkedResources(String propertyName) Retrieves all the linked resources of a property.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.Gets the native object underneath.Gets the parent instance.Gets the value of a property.voidrefresh()Refresh all children values cachevoidRefresh children cache for given propertybooleansave()Saves the resource.booleanSaves a specified property.voidsetCreatedBy(IUser createdBy) Sets the creator of the resource.voidsetCreatedDate(Date date) Sets the created date.voidsetList(String propertyName, Collection value) 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 propertyvoidvoidsetValueNoEvents(String propertyName, Object value) Sets a value to a property without throwing any event.toMap()Methods inherited from class com.axemble.vdoc.sdk.impl.ProcessElementgetId, getPath, getProtocolURI, getProtocolURI, getWorkflowModule, saveMethods inherited from class com.axemble.vdoc.sdk.impl.AbstractElementgetModuleMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.axemble.vdoc.sdk.interfaces.IElementgetId, getModule, getPath, saveMethods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupportgetProtocolURI, getProtocolURI
- 
Field Details- 
LOGGERpublic static final com.axemble.vdp.utils.Logger LOGGER
- 
documentprotected com.axemble.vdp.ui.core.document.GenericDocument document
- 
createdBy
- 
createdDate
- 
modifiedBy
- 
modifiedDate
 
- 
- 
Constructor Details- 
GenericResource- Parameters:
- module-
 
 
- 
- 
Method Details- 
addLinkedResourceDescription copied from interface:IResourceAllows to add a linked resource.- Specified by:
- addLinkedResourcein interface- IResource
- Parameters:
- linkedResource- The- ILinkedResourceto add.
- Returns:
- true if succeed, 
} otherwise.invalid @link{@link false
 
- 
addLinkedResourcesDescription copied from interface:IResourceAllows to add linked resources.- Specified by:
- addLinkedResourcesin interface- IResource
- Parameters:
- linkedResources- The collection of- ILinkedResourceobjects to add.
- Returns:
- true if succeed, 
} otherwise.invalid @link{@link false
 
- 
allowEventspublic void allowEvents()Description copied from interface:IResourceAllows events to be thrown.- Specified by:
- allowEventsin interface- IResource
 
- 
denyEventspublic void denyEvents()Description copied from interface:IResourcePrevents from throwing events.- Specified by:
- denyEventsin interface- IResource
 
- 
createLinkedResourceDescription copied from interface:IResourceCreates a linked resource within a property.- Specified by:
- createLinkedResourcein interface- IResource
- Parameters:
- propertyName- The system name of the property.
- Returns:
- a ILinkedResourceobject.
 
- 
deleteLinkedResourceDescription copied from interface:IResourceAllows to remove a linked resource.- Specified by:
- deleteLinkedResourcein interface- IResource
- Parameters:
- linkedResource- The- ILinkedResourceto remove.
 
- 
deleteLinkedResourcesDescription copied from interface:IResourceAllows to remove a collection of linked resources.- Specified by:
- deleteLinkedResourcesin interface- IResource
- Parameters:
- linkedResources- The collection of- ILinkedResourceobjects.
 
- 
existsDescription copied from interface:IResourceChecks if a property exists.
- 
getCreatedByDescription copied from interface:IResourceGets the creator of the resource.- Specified by:
- getCreatedByin interface- IResource
- Returns:
- a IUserobject.
 
- 
getCreatedDateDescription copied from interface:IResourceGets the created date.- Specified by:
- getCreatedDatein interface- IResource
- Returns:
- a Dateobject.
 
- 
getDefinitionDescription copied from interface:IResourceGets the definition of the resource- Specified by:
- getDefinitionin interface- IResource
- Returns:
- A IResourceDefinitionobject.
 
- 
getHistoryDescription copied from interface:IResourceGets the history of the resource- Specified by:
- getHistoryin interface- IResource
- Returns:
- a IResourceHistoryobject.
 
- 
getLinkedResourcesDescription copied from interface:IResourceRetrieves all the linked resources of a property.- Specified by:
- getLinkedResourcesin interface- IResource
- Parameters:
- propertyName- The system name of the property.
- Returns:
- A java.util.Collection of ILinkedResourceobjects.
 
- 
getListDescription copied from interface:IResourceGets the available values of a list property.- Specified by:
- getListin interface- IResource
- Parameters:
- propertyName- The system name of the property.
- Returns:
- A java.util.Collection of IOptionList.IOption.
 
- 
getModifiedByDescription copied from interface:IResourceGets the last user who modified the resource.- Specified by:
- getModifiedByin interface- IResource
- Returns:
- a IUserobject.
 
- 
getModifiedDateDescription copied from interface:IResourceGets the modified date.- Specified by:
- getModifiedDatein interface- IResource
- Returns:
- a Dateobject.
 
- 
getNameDescription copied from interface:IResourceGets the name of a resource.
- 
getValueDescription copied from interface:IResourceGets the value of a property.
- 
savepublic boolean save()Description copied from interface:IResourceSaves the resource.
- 
saveDescription copied from interface:IResourceSaves a specified property.
- 
setCreatedDateDescription copied from interface:IResourceSets the created date.- Specified by:
- setCreatedDatein interface- IResource
- Parameters:
- date- The- Dateto set.
 
- 
setCreatedByDescription copied from interface:IResourceSets the creator of the resource. Can only be set if the resource has not been created yet- Specified by:
- setCreatedByin interface- IResource
- Parameters:
- createdBy- The creator- IUserof the resource.
 
- 
setListDescription copied from interface:IResourceSets the available values for a list property.- Specified by:
- setListin interface- IResource
- Parameters:
- propertyName- The system name of the property.
- value- A java.util.Collection of- IOptionList.IOptionobjects..
 
- 
setModifiedByDescription copied from interface:IResourceSets last user who modified the resource.- Specified by:
- setModifiedByin interface- IResource
- Parameters:
- user- The last- IUserwho modified the resource.
 
- 
setModifiedDateDescription copied from interface:IResourceSets the modified date.- Specified by:
- setModifiedDatein interface- IResource
- Parameters:
- date- The- Dateto set.
 
- 
setValueDescription copied from interface:IResourceSets a value to a property
- 
setValue
- 
setValueNoEventsDescription copied from interface:IResourceSets a value to a property without throwing any event.- Specified by:
- setValueNoEventsin interface- IResource
- Parameters:
- propertyName- The system name of the property.
- value- The value object to set.
 
- 
getNativeObjectDescription copied from interface:IElementGets the native object underneath.- Specified by:
- getNativeObjectin interface- IElement
- Returns:
- an object.
 
- 
deleteDescription copied from interface:IDeletionSupportDeletes theIElementobject.- Specified by:
- deletein interface- IDeletionSupport
- Parameters:
- context- The Execution context.
 
- 
getCatalogDescription copied from interface:ILinkedResourceGets the catalog of the linked resource- Specified by:
- getCatalogin interface- ILinkedResource
- Returns:
- A ICatalogobject.
 
- 
getParentInstanceDescription copied from interface:ILinkedResourceGets the parent instance.- Specified by:
- getParentInstancein interface- ILinkedResource
- Returns:
- A IWorkflowInstanceobject.
 
- 
fromMap
- 
toMap
- 
getDocumentpublic com.axemble.vdp.ui.core.document.GenericDocument getDocument()- Returns:
- the document
 
- 
refreshpublic void refresh()Description copied from interface:IResourceRefresh all children values cache
- 
refreshDescription copied from interface:IResourceRefresh children cache for given property
- 
getText
 
-