oracle.ifs.beans

Class ApplicationTokenDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.ApplicationObjectDefinition

oracle.ifs.beans.ApplicationTokenDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ApplicationTokenDefinition
extends ApplicationObjectDefinition

An ApplicationTokenDefinition is used to create or modify an ApplicationToken instance.

Author:

Dave Long

See Also:

Serialized Form

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
ApplicationTokenDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ApplicationTokenDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
Long	getTimeoutPeriodOption() Gets the timeout period (milliseconds) that has been set.
void	setTimeoutPeriodOption(long timeout) Sets the timeout period (milliseconds) for the ApplicationToken.
void	setTokenInfo(String tokenInfo) Set the Token Info.
void	setTokenValue(String tokenValue) Set the Token value.
static ApplicationTokenDefinition	toApplicationTokenDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a ApplicationTokenDefinition.
static ApplicationTokenDefinition	toApplicationTokenDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a ApplicationTokenDefinition.

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, prepareForDefinitionObject, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApplicationTokenDefinition

public ApplicationTokenDefinition(LibrarySessionInterface session)
                           throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be ApplicationToken.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ApplicationTokenDefinition

public ApplicationTokenDefinition(LibrarySessionInterface session,
                                  String className)
                           throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class PublicObjectDefinition

Parameters:

avt - the table having the definition settings

Throws:

IfsException - if the operation fails

(Published)

setTokenValue

public void setTokenValue(String tokenValue)
                   throws IfsException

Set the Token value.

Parameters:

tokenValue - token value to be used for the target object

Throws:

IfsException - if the operation fails.

(Unpublished)

setTokenInfo

public void setTokenInfo(String tokenInfo)
                  throws IfsException

Set the Token Info.

Parameters:

tokenInfo - token info to be used for the target object

Throws:

IfsException - if the operation fails.

(Unpublished)

setTimeoutPeriodOption

public void setTimeoutPeriodOption(long timeout)
                            throws IfsException

Sets the timeout period (milliseconds) for the ApplicationToken.

This period is added to the current time at the time the ApplicationToken is created or updated with this definition, producing the new ExpirationDate for the instance.

Parameters:

timeout - the timeout period (milliseconds)

Throws:

IfsException - if the operation fails

getTimeoutPeriodOption

public Long getTimeoutPeriodOption()
                            throws IfsException

Gets the timeout period (milliseconds) that has been set.

Returns:

the timeout period value, or null if not set

Throws:

IfsException - if the operation fails

toApplicationTokenDefinition

public static ApplicationTokenDefinition toApplicationTokenDefinition(LibraryObjectDefinition lodef)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a ApplicationTokenDefinition.

Return null if the specified definition is not a ApplicationTokenDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a ApplicationTokenDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toApplicationTokenDefinition

public static ApplicationTokenDefinition toApplicationTokenDefinition(LibraryObjectDefinition lodef,
                                                                      boolean enforceCompat)
                                                               throws IfsException

Cast specified LibraryObjectDefinition to a ApplicationTokenDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a ApplicationTokenDefinition.

Parameters:

lodef - the definition to be casted

enforceCompat - whether to throw an exception if a non-null definition cannot be cast

Returns:

a ApplicationTokenDefinition casted from the specified definition

Throws:

IfsException - 10822: if the operation fails.

(Unpublished)