public class LifecyclePolicyActionSpecification extends TieSystemObject
Modifier and Type | Field and Description |
---|---|
static String |
CLASS_NAME
The name of the ClassObject representing this class.
|
static String |
DESCRIPTION_ATTRIBUTE
The name of the attribute that holds the description of
this LifecyclePolicyActionSpecification.
|
static String |
LIFECYCLEPOLICYACTIONCLASSNAME_ATTRIBUTE
The name of the attribute that holds fully-qualified class name
of the LifecyclePolicyAction class.
|
static String |
NAME_ATTRIBUTE
The name of the attribute that holds the name of
this LifecyclePolicyActionSpecification.
|
ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session
Modifier | Constructor and Description |
---|---|
protected |
LifecyclePolicyActionSpecification(LibrarySession session,
Long id,
Long classId,
S_LibraryObjectData data)
Construct a LifecyclePolicyActionSpecification object.
|
Modifier and Type | Method and Description |
---|---|
static LifecyclePolicyActionSpecification[] |
findAll(LibrarySession session)
Returns the set of defined LifecyclePolicyActionSpecifications.
|
static LifecyclePolicyActionSpecification |
findByName(LibrarySession session,
String name)
Returns the a LifecyclePolicyActionSpecification matching the
specified name.
|
String |
getDescription()
Gets the description of this LifecyclePolicyActionSpecification.
|
LifecyclePolicyAction |
getLifecyclePolicyAction()
Gets the LifecyclePolicyAction instance implementation
corresponding to the LifecyclePolicyActionClassName.
|
String |
getLifecyclePolicyActionClassName()
Gets the fully-qualified class name of the LifecyclePolicyAction class.
|
void |
handleEvent(IfsEvent event)
Handles the specified event.
|
boolean |
hasNameAttribute()
Returns true if this object is an instance of a class
that has a NAME attribute, and false otherwise.
|
protected void |
preCreate(LibraryObjectDefinition lodef)
Extensibility point to perform actions prior to the
creation of a PublicObject.
|
protected void |
preFree(LibraryObjectDefinition lodef)
Extensibility point to perform actions prior to the
permanent deletion ("free") of a object.
|
protected void |
preUpdate(LibraryObjectDefinition lodef)
Extensibility point to perform actions prior to the update of
a PublicObject.
|
addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists
added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface
getTraceLogger, isTraced, trace
public static final String CLASS_NAME
public static final String NAME_ATTRIBUTE
public static final String DESCRIPTION_ATTRIBUTE
public static final String LIFECYCLEPOLICYACTIONCLASSNAME_ATTRIBUTE
protected LifecyclePolicyActionSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) throws IfsException
session
- current LibrarySessionid
- object idclassId
- class iddata
- data componentIfsException
- if the operation failspublic boolean hasNameAttribute() throws IfsException
LibraryObject
hasNameAttribute
in class LibraryObject
IfsException
- if operation fails.public String getDescription() throws IfsException
IfsException
- if operation failspublic String getLifecyclePolicyActionClassName() throws IfsException
IfsException
- if operation failspublic static LifecyclePolicyActionSpecification[] findAll(LibrarySession session) throws IfsException
The instances will be sorted by name.
session
- the session contextIfsException
- if the operation fails.public static LifecyclePolicyActionSpecification findByName(LibrarySession session, String name) throws IfsException
LifecyclePolicyActionSpecification names are case sensitive, so this operations requires an exact match with respect to case.
session
- the session contextname
- the LifecyclePolicyActionSpecification nameIfsException
- if the operation fails.protected void preCreate(LibraryObjectDefinition lodef) throws IfsException
Set an option that indicates that Categories are NOT to be created from within S_SystemObject.
preCreate
in class SystemObject
lodef
- object definition that will be used to create the objectIfsException
- if operation failsprotected void preUpdate(LibraryObjectDefinition lodef) throws IfsException
Set an option that indicates that Categories are NOT to be created from within S_SystemObject.
preUpdate
in class SystemObject
lodef
- definition used to define how the target object
will be updatedIfsException
- if operation failsprotected void preFree(LibraryObjectDefinition lodef) throws IfsException
LibraryObject
This method is typically overridden by subclasses that
perform other operations prior to the target object
being freed in order to all delete or modify objects related
to the target object.
Subclasses are expected to invoke super.preFree
.
preFree
in class LibraryObject
lodef
- object definition used to hold options related to the free
operationIfsException
- if operation fails.public final LifecyclePolicyAction getLifecyclePolicyAction() throws IfsException
This implementation is cached for use by the session associated with this instance. There is no guarantee that there is only one implementation in use for the session if the session is used in multiple threads.
IfsException
- if the operation failspublic void handleEvent(IfsEvent event) throws IfsException
LibraryObject
handleEvent
in interface IfsEventHandler
handleEvent
in class LibraryObject
event
- the eventIfsException
- if the operation failsCopyright © 2023. All rights reserved.