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
Modifier and TypeFieldDescriptionprotected IUser
protected Date
protected com.axemble.vdp.ui.core.document.GenericDocument
static final com.axemble.vdp.utils.Logger
protected IUser
protected Date
Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement
module
-
Constructor Summary
ConstructorDescriptionGenericResource
(IModule module, com.axemble.vdp.ui.core.document.GenericDocument document) -
Method Summary
Modifier and TypeMethodDescriptionboolean
addLinkedResource
(ILinkedResource linkedResource) Allows to add a linked resource.boolean
addLinkedResources
(Collection linkedResources) Allows to add linked resources.void
Allows events to be thrown.createLinkedResource
(String propertyName) Creates a linked resource within a property.void
Deletes theIElement
object.void
deleteLinkedResource
(ILinkedResource linkedResource) Allows to remove a linked resource.void
deleteLinkedResources
(Collection linkedResources) Allows to remove a collection of linked resources.void
Prevents from throwing events.boolean
Checks if a property exists.void
Gets 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.GenericDocument
Gets 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.void
refresh()
Refresh all children values cachevoid
Refresh children cache for given propertyboolean
save()
Saves the resource.boolean
Saves a specified property.void
setCreatedBy
(IUser createdBy) Sets the creator of the resource.void
setCreatedDate
(Date date) Sets the created date.void
setList
(String propertyName, Collection value) Sets the available values for a list property.void
setModifiedBy
(IUser user) Sets last user who modified the resource.void
setModifiedDate
(Date date) Sets the modified date.void
Sets a value to a propertyvoid
void
setValueNoEvents
(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, save
Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement
getModule
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement
getId, getModule, getPath, save
Methods 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:IResource
Allows to add a linked resource.- Specified by:
addLinkedResource
in interfaceIResource
- Parameters:
linkedResource
- TheILinkedResource
to add.- Returns:
- true if succeed,
invalid @link
{@link false
-
addLinkedResources
Description copied from interface:IResource
Allows to add linked resources.- Specified by:
addLinkedResources
in interfaceIResource
- Parameters:
linkedResources
- The collection ofILinkedResource
objects to add.- Returns:
- true if succeed,
invalid @link
{@link false
-
allowEvents
public void allowEvents()Description copied from interface:IResource
Allows events to be thrown.- Specified by:
allowEvents
in interfaceIResource
-
denyEvents
public void denyEvents()Description copied from interface:IResource
Prevents from throwing events.- Specified by:
denyEvents
in interfaceIResource
-
createLinkedResource
Description copied from interface:IResource
Creates a linked resource within a property.- Specified by:
createLinkedResource
in interfaceIResource
- Parameters:
propertyName
- The system name of the property.- Returns:
- a
ILinkedResource
object.
-
deleteLinkedResource
Description copied from interface:IResource
Allows to remove a linked resource.- Specified by:
deleteLinkedResource
in interfaceIResource
- Parameters:
linkedResource
- TheILinkedResource
to remove.
-
deleteLinkedResources
Description copied from interface:IResource
Allows to remove a collection of linked resources.- Specified by:
deleteLinkedResources
in interfaceIResource
- Parameters:
linkedResources
- The collection ofILinkedResource
objects.
-
exists
Description copied from interface:IResource
Checks if a property exists. -
getCreatedBy
Description copied from interface:IResource
Gets the creator of the resource.- Specified by:
getCreatedBy
in interfaceIResource
- Returns:
- a
IUser
object.
-
getCreatedDate
Description copied from interface:IResource
Gets the created date.- Specified by:
getCreatedDate
in interfaceIResource
- Returns:
- a
Date
object.
-
getDefinition
Description copied from interface:IResource
Gets the definition of the resource- Specified by:
getDefinition
in interfaceIResource
- Returns:
- A
IResourceDefinition
object.
-
getHistory
Description copied from interface:IResource
Gets the history of the resource- Specified by:
getHistory
in interfaceIResource
- Returns:
- a
IResourceHistory
object.
-
getLinkedResources
Description copied from interface:IResource
Retrieves all the linked resources of a property.- Specified by:
getLinkedResources
in interfaceIResource
- Parameters:
propertyName
- The system name of the property.- Returns:
- A java.util.Collection of
ILinkedResource
objects.
-
getList
Description copied from interface:IResource
Gets the available values of a list property.- Specified by:
getList
in interfaceIResource
- Parameters:
propertyName
- The system name of the property.- Returns:
- A java.util.Collection of
IOptionList.IOption
.
-
getModifiedBy
Description copied from interface:IResource
Gets the last user who modified the resource.- Specified by:
getModifiedBy
in interfaceIResource
- Returns:
- a
IUser
object.
-
getModifiedDate
Description copied from interface:IResource
Gets the modified date.- Specified by:
getModifiedDate
in interfaceIResource
- Returns:
- a
Date
object.
-
getName
Description copied from interface:IResource
Gets the name of a resource. -
getValue
Description copied from interface:IResource
Gets the value of a property. -
save
public boolean save()Description copied from interface:IResource
Saves the resource. -
save
Description copied from interface:IResource
Saves a specified property. -
setCreatedDate
Description copied from interface:IResource
Sets the created date.- Specified by:
setCreatedDate
in interfaceIResource
- Parameters:
date
- TheDate
to set.
-
setCreatedBy
Description copied from interface:IResource
Sets the creator of the resource. Can only be set if the resource has not been created yet- Specified by:
setCreatedBy
in interfaceIResource
- Parameters:
createdBy
- The creatorIUser
of the resource.
-
setList
Description copied from interface:IResource
Sets the available values for a list property.- Specified by:
setList
in interfaceIResource
- Parameters:
propertyName
- The system name of the property.value
- A java.util.Collection ofIOptionList.IOption
objects..
-
setModifiedBy
Description copied from interface:IResource
Sets last user who modified the resource.- Specified by:
setModifiedBy
in interfaceIResource
- Parameters:
user
- The lastIUser
who modified the resource.
-
setModifiedDate
Description copied from interface:IResource
Sets the modified date.- Specified by:
setModifiedDate
in interfaceIResource
- Parameters:
date
- TheDate
to set.
-
setValue
Description copied from interface:IResource
Sets a value to a property -
setValue
-
setValueNoEvents
Description copied from interface:IResource
Sets a value to a property without throwing any event.- Specified by:
setValueNoEvents
in interfaceIResource
- Parameters:
propertyName
- The system name of the property.value
- The value object to set.
-
getNativeObject
Description copied from interface:IElement
Gets the native object underneath.- Specified by:
getNativeObject
in interfaceIElement
- Returns:
- an object.
-
delete
Description copied from interface:IDeletionSupport
Deletes theIElement
object.- Specified by:
delete
in interfaceIDeletionSupport
- Parameters:
context
- The Execution context.
-
getCatalog
Description copied from interface:ILinkedResource
Gets the catalog of the linked resource- Specified by:
getCatalog
in interfaceILinkedResource
- Returns:
- A
ICatalog
object.
-
getParentInstance
Description copied from interface:ILinkedResource
Gets the parent instance.- Specified by:
getParentInstance
in interfaceILinkedResource
- Returns:
- A
IWorkflowInstance
object.
-
fromMap
-
toMap
-
getDocument
public com.axemble.vdp.ui.core.document.GenericDocument getDocument()- Returns:
- the document
-
refresh
public void refresh()Description copied from interface:IResource
Refresh all children values cache -
refresh
Description copied from interface:IResource
Refresh children cache for given property -
getText
-