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 Summary
FieldsModifier 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.AbstractElement
module -
Constructor Summary
ConstructorsConstructorDescriptionGenericResource(IModule module, com.axemble.vdp.ui.core.document.GenericDocument document) -
Method Summary
Modifier 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.ProcessElement
getId, getPath, getProtocolURI, getProtocolURI, getWorkflowModule, saveMethods 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.interfaces.IElement
getId, getModule, getPath, saveMethods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport
getProtocolURI, getProtocolURI
-
Field Details
-
LOGGER
public static final com.axemble.vdp.utils.Logger LOGGER -
document
protected com.axemble.vdp.ui.core.document.GenericDocument document -
createdBy
-
createdDate
-
modifiedBy
-
modifiedDate
-
-
Constructor Details
-
GenericResource
- Parameters:
module-
-
-
Method Details
-
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
-
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
-
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.
-
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.
-
exists
Description copied from interface:IResourceChecks if a property exists. -
getCreatedBy
Description copied from interface:IResourceGets the creator of the resource.- Specified by:
getCreatedByin interfaceIResource- Returns:
- a
IUserobject.
-
getCreatedDate
Description copied from interface:IResourceGets the created date.- Specified by:
getCreatedDatein interfaceIResource- Returns:
- a
Dateobject.
-
getDefinition
Description copied from interface:IResourceGets the definition of the resource- Specified by:
getDefinitionin interfaceIResource- Returns:
- A
IResourceDefinitionobject.
-
getHistory
Description copied from interface:IResourceGets the history of the resource- Specified by:
getHistoryin interfaceIResource- Returns:
- a
IResourceHistoryobject.
-
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.
-
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.
-
getModifiedBy
Description copied from interface:IResourceGets the last user who modified the resource.- Specified by:
getModifiedByin interfaceIResource- Returns:
- a
IUserobject.
-
getModifiedDate
Description copied from interface:IResourceGets the modified date.- Specified by:
getModifiedDatein interfaceIResource- Returns:
- a
Dateobject.
-
getName
Description copied from interface:IResourceGets the name of a resource. -
getValue
Description copied from interface:IResourceGets the value of a property. -
save
public boolean save()Description copied from interface:IResourceSaves the resource. -
save
Description copied from interface:IResourceSaves a specified property. -
setCreatedDate
Description copied from interface:IResourceSets the created date.- Specified by:
setCreatedDatein 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:
createdBy- The creatorIUserof the resource.
-
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.value- A java.util.Collection ofIOptionList.IOptionobjects..
-
setModifiedBy
Description copied from interface:IResourceSets last user who modified the resource.- Specified by:
setModifiedByin interfaceIResource- Parameters:
user- The lastIUserwho modified the resource.
-
setModifiedDate
Description copied from interface:IResourceSets the modified date.- Specified by:
setModifiedDatein interfaceIResource- Parameters:
date- TheDateto set.
-
setValue
Description copied from interface:IResourceSets a value to a property -
setValue
-
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.
-
getNativeObject
Description copied from interface:IElementGets the native object underneath.- Specified by:
getNativeObjectin interfaceIElement- Returns:
- an object.
-
delete
Description copied from interface:IDeletionSupportDeletes theIElementobject.- Specified by:
deletein interfaceIDeletionSupport- Parameters:
context- The Execution context.
-
getCatalog
Description copied from interface:ILinkedResourceGets the catalog of the linked resource- Specified by:
getCatalogin interfaceILinkedResource- Returns:
- A
ICatalogobject.
-
getParentInstance
Description copied from interface:ILinkedResourceGets the parent instance.- Specified by:
getParentInstancein interfaceILinkedResource- Returns:
- A
IWorkflowInstanceobject.
-
fromMap
-
toMap
-
getDocument
public com.axemble.vdp.ui.core.document.GenericDocument getDocument()- Returns:
- the document
-
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
-