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
Modifier and TypeFieldDescriptionprotected com.axemble.vdp.ui.core.document.CoreDocument
Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement
module
-
Constructor Summary
ModifierConstructorDescriptionprotected
ProcessResource
(IModule module) protected
ProcessResource
(IModule module, com.axemble.vdp.ui.core.document.CoreDocument document) -
Method Summary
Modifier and TypeMethodDescriptionboolean
addLinkedResource
(ILinkedResource linkedResource) Allows to add a linked resource.boolean
addLinkedResources
(Collection<? extends ILinkedResource> 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<? extends ILinkedResource> linkedResources) Allows to remove a collection of linked resources.void
Prevents from throwing events.boolean
Checks 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.CoreDocument
com.axemble.vdoc.core.utils.IntrospectionObject
Gets 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.BaseDomain
Gets the native object underneath.Gets the value of a property.com.axemble.vdoc.core.utils.IntrospectionObject
void
refresh()
Refresh all children values cachevoid
Refresh children cache for given propertyboolean
save()
Saves the resource.boolean
Saves or updates the element.boolean
Saves a specified property.boolean
void
setCreatedBy
(IUser user) Sets the creator of the resource.void
setCreatedDate
(Date date) Sets the created date.void
setList
(String propertyName, Collection<? extends IOptionList.IOption> values) 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
setValueNoEvents
(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, getWorkflowModule
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.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:IElement
Gets the identifier object.- Specified by:
getId
in interfaceIElement
- Overrides:
getId
in classProcessElement
- Returns:
- a
IStorageKey
object.
-
getNativeObject
Description copied from interface:IElement
Gets the native object underneath.- Specified by:
getNativeObject
in interfaceIElement
- Returns:
- an object.
-
getNativeDomain
public com.axemble.vdoc.core.domain.BaseDomain getNativeDomain()- Specified by:
getNativeDomain
in interfaceSDKWrapper
-
getDocument
public com.axemble.vdp.ui.core.document.CoreDocument getDocument() -
getCreatedDate
Description copied from interface:IResource
Gets the created date.- Specified by:
getCreatedDate
in interfaceIResource
- Returns:
- a
Date
object.
-
setCreatedDate
Description copied from interface:IResource
Sets the created date.- Specified by:
setCreatedDate
in interfaceIResource
- Parameters:
date
- TheDate
to set.
-
getModifiedDate
Description copied from interface:IResource
Gets the modified date.- Specified by:
getModifiedDate
in interfaceIResource
- Returns:
- a
Date
object.
-
setModifiedDate
Description copied from interface:IResource
Sets the modified date.- Specified by:
setModifiedDate
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:
user
- The creatorIUser
of the resource.
-
getCreatedBy
Description copied from interface:IResource
Gets the creator of the resource.- Specified by:
getCreatedBy
in interfaceIResource
- Returns:
- a
IUser
object.
-
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.
-
getModifiedBy
Description copied from interface:IResource
Gets the last user who modified the resource.- Specified by:
getModifiedBy
in interfaceIResource
- Returns:
- a
IUser
object.
-
getName
Description copied from interface:IResource
Gets the name of a resource. -
exists
Description copied from interface:IResource
Checks if a property exists. -
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.
-
setValue
Description copied from interface:IResource
Sets a value to a property -
getValue
Description copied from interface:IResource
Gets the value of a property. -
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.values
- A java.util.Collection ofIOptionList.IOption
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
.
-
getDefinition
Description copied from interface:IResource
Gets the definition of the resource- Specified by:
getDefinition
in interfaceIResource
- Returns:
- A
IResourceDefinition
object.
-
getCatalog
-
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.
-
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
-
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.
-
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.
-
getHistory
Description copied from interface:IResource
Gets the history of the resource- Specified by:
getHistory
in interfaceIResource
- Returns:
- a
IResourceHistory
object.
-
save
Description copied from interface:IElement
Saves or updates the element.- Specified by:
save
in interfaceIElement
- Overrides:
save
in classProcessElement
- Parameters:
context
- The Execution context.- Returns:
- return true if succeeded, false otherwise.
-
save
public boolean save()Description copied from interface:IResource
Saves the resource. -
save
Description copied from interface:IResource
Saves a specified property. -
saveNoEvents
public boolean saveNoEvents()- Specified by:
saveNoEvents
in interfacecom.axemble.vdp.resource.interfaces.InternalResource
-
delete
Description copied from interface:IDeletionSupport
Deletes theIElement
object.- Specified by:
delete
in interfaceIDeletionSupport
- Parameters:
context
- The Execution context.
-
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
-
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
-
getValues
public com.axemble.vdoc.core.utils.IntrospectionObject getValues()- Specified by:
getValues
in interfacecom.axemble.vdp.resource.interfaces.InternalResource
-
getFields
public com.axemble.vdoc.core.utils.IntrospectionObject getFields()- Specified by:
getFields
in interfacecom.axemble.vdp.resource.interfaces.InternalResource
-