ScriptOperations (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.tools.script.ScriptOperations

All Implemented Interfaces:

AttributeValueGetter, Logger

Direct Known Subclasses:

AclIndexOperations, AclOperations, ActivityOperations, AgentOperations, BaseTestOperations, CodeGenerationOperations, CommandProcessorOperations, CoreNlpOperations, CursorOperations, ExtractionOperations, FolderIndexOperations, GroupOperations, InstallOperations, LinkOperations, LockOperations, PropertyBundleOperations, RuntimeOperations, SchemaCategoryOperations, SecuredByOperations, SportsOperations, SystemCategoryOperations, UpgradeOperations, ViewOperations
```
public class ScriptOperations
extends Object
implements Logger, AttributeValueGetter
```
A ScriptOperations defines the administration operations that can be executed by a test or schema creation component using the ScriptDriver class.
This makes use of the framework provided by ScriptDriver and related classes in its package.

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ScriptOperations.ClassObjectOptions` Structure that holds options used to fully create a new ClassObject.
`class`	`ScriptOperations.JdbcExecutor`
`static class`	`ScriptOperations.SavedSearchResult` Structure that holds saved saerch results.
`static class`	`ScriptOperations.ServerDefinition` Structure holds data require to construct a single server entry property within a node.
`static class`	`ScriptOperations.ServiceDefinition` Structure holds data require to construct a single service entry property within a node.

Field Summary

Fields
Modifier and Type Field and Description

static String INDENT
Amount to indent when displaying layered information

Fields
Modifier and Type	Field and Description
`static String`	`INDENT` Amount to indent when displaying layered information

Constructor Summary

Constructors
Constructor and Description

ScriptOperations(ScriptDriver driver)
Construct a ScriptOperations

Constructors
Constructor and Description
`ScriptOperations(ScriptDriver driver)` Construct a ScriptOperations

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`abortTransaction(String trantag)` Abort an outer transaction.
`void`	`acquireLock(String poTag, String sleTag)` Acquire the specified SystemLockEntry lock.
`void`	`acquireManualLock(String leTag, String poTag)` Acquire a manual lock.
`void`	`activateAuditHandlerSpecification(String specName)` Sets an AuditSpecificationHandler to an active state.
`void`	`activateAuditSpecification(String specName)` Sets an AuditSpecification to an active state.
`void`	`activateOperationActionSpecification(String tagOrName)` Activate a OperationActionSpecification.
`void`	`activateServerSpecification(String specName)` Sets an ServerSpecification to an active state.
`void`	`activateSystemObject(String objectTag)` Activate a SystemObject.
`void`	`addAttachment(AttributeValueTable avt)` Add an attachment to the specified target PublicObject.
`void`	`addAttribute(AttributeValueTable avt)` Create a new Attribute for an existing ClassObject.
`void`	`addAuditEventProperty(String propName, String propValue)` Add an audit event property to an internal list, to be posted as part of the next postCustomAuditEvent operation.
`void`	`addAuditType(String defTag, String eventType, String mode)` Adds an event type to an AuditTypeList definition.
`void`	`addAuditTypesForClass(String defTag, String className, String mode)` Adds types to an AuditTypeList definition for a class.
`void`	`addBooleanHandlerProperty(String defTag, String propName, String propValue)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addCategory(AttributeValueTable avt)` Adds a category to an existing PublicObject.
`void`	`addDefinitionAuditEntryType(String defTag, String opTypeKey, String opModeString)` Add an AuditEntryType to an AuditTypeList definition.
`void`	`addDefinitionAuditEntryTypesForClass(String defTag, String className, String opMode)` Add AuditEntryTypes to an AuditTypeList definition for the events that are applicable to the class specified.
`void`	`addDefinitionAuditEntryTypesUnderClass(String defTag, String className, String opMode)` Add AuditEntryTypes to an AuditTypeList definition for the events that are applicable to the class specified, and any classes that are considered descendents of that class.
`void`	`addDefinitionBooleanProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDefinitionDoubleProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDefinitionIntegerProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDefinitionLongProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDefinitionProperties(AttributeValueTable avt)` Add definition properties, using a reference object or definition as the source of the property settings.
`void`	`addDefinitionProperty(AttributeValueTable avt)` Adds a property to a definition.
`void`	`addDefinitionStringArrayProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDefinitionStringProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addDocumentDefinitionCharacterSet(String defTag, String charSet)` Deprecated. 9.0.4.6: use `addToDocumentDefinition`
`void`	`addDocumentDefinitionContent(String defTag, String contentFileName)` Deprecated. 9.0.4.6: use `addToDocumentDefinition`
`void`	`addDocumentDefinitionContentBfileReference(String defTag, String osParentFolderPath, String bfileName, String lengthStr)` Deprecated. 9.0.4.6: use `addToDocumentDefinition`
`void`	`addDocumentDefinitionLanguage(String defTag, String lang)` Deprecated. 9.0.4.6: use `addToDocumentDefinition`
`void`	`addGlobalOperationActionSpecification(String specName)` Adds an OperationActionSpecification to the list of global OperationActionSpecifications, defined in a domain property.
`void`	`addGroupMember(AttributeValueTable avt)` Adds a member to a DirectoryGroup.
`void`	`addGroupMembers(AttributeValueTable avt)` Adds members to a DirectoryGroup.
`void`	`addIntegerHandlerProperty(String defTag, String propName, String propValue)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addLifecyclePolicyEntryDefinition(String lpDefTag, String lpeDefTag)` Add a LifecyclePolicyEntry definition to a LifecyclePolicy definition.
`void`	`addLifecyclePolicyEntryDefinition(String defTag, String lpeName, String lpeDesc, String actionTag, String timePeriod, String execPeriod, String execBaseTime)` Add a LifecyclePolicyEntry definition to a LifecyclePolicy definition.
`void`	`addLongHandlerProperty(String defTag, String propName, String propValue)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addManagedServerDeclaration(AttributeValueTable avt)` Add a Server declaration to the list being prepared as the set of managed Servers, used in the next `createNodeConfiguration` operation.
`void`	`addManagedServerDeclaration(ScriptOperations.ServerDefinition serverDef)` Add a Server declaration to the list being prepared as the set of managed Servers, used in the next `createNodeConfiguration` operation.
`void`	`addManagedServerDeclaration(String serverName, String scName, String serviceName, String activeVal, String startedVal, String priorityVal)` Add a Server declaration to the list being prepared as the set of managed Servers, used in the next `createNodeConfiguration` operation.
`void`	`addManagedServiceDeclaration(ScriptOperations.ServiceDefinition serviceDef)` Add a Service declaration to the list being prepared as the set of managed Services, used in the next `createNodeConfiguration` operation.
`void`	`addManagedServiceDeclaration(String serviceName, String svcName, String activeVal)` Add a Service declaration to the list being prepared as the set of managed Services, used in the next `createNodeConfiguration` operation.
`void`	`addPreparedSelectorBindValue(AttributeValueTable avt)` Add an bind value to an internal list, to be used as the bind values in the next executeRawPreparedSelect operation.
`void`	`addPreparedSelectorBooleanBindValue(String bindValue)` Deprecated. 9.0.4.6: use `addPreparedSelectorBindValue`
`void`	`addPreparedSelectorIntegerBindValue(String bindValue)` Deprecated. 9.0.4.6: use `addPreparedSelectorBindValue`
`void`	`addPreparedSelectorLibraryObjectBindValue(String objTag)` Deprecated. 9.0.4.6: use `addPreparedSelectorBindValue`
`void`	`addPreparedSelectorLongBindValue(String bindValue)` Deprecated. 9.0.4.6: use `addPreparedSelectorBindValue`
`void`	`addPreparedSelectorStringBindValue(String bindValue)` Deprecated. 9.0.4.6: use `addPreparedSelectorBindValue`
`void`	`addPublicObjectDefinitionCategory(String defTag, String catdefTag)` Add a category definition to a PublicObject definition.
`void`	`addSchemaObjectDefinitionCategory(String defTag, String catdefTag)` Add a schema category definition to a SchemaObject definition.
`void`	`addStringArrayHandlerProperty(String defTag, String propName, String propValue)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addStringHandlerProperty(String defTag, String propName, String propValue)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addSystemObjectDefinitionBooleanProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addSystemObjectDefinitionCategory(String defTag, String catdefTag)` Add a system category definition to a SystemObject definition.
`void`	`addSystemObjectDefinitionIntegerProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addSystemObjectDefinitionLongProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addSystemObjectDefinitionStringArrayProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addSystemObjectDefinitionStringProperty(String defTag, String key, String value)` Deprecated. 9.0.4.6: use `addDefinitionProperty`
`void`	`addToDocumentDefinition(AttributeValueTable avt)` Add options to a Document definition.
`void`	`addToPublicObjectDefinition(AttributeValueTable avt)` Add options to a PublicObject definition.
`void`	`applyLogLevelOverride(String logEntry)` Apply a log level overrides.
`void`	`applyNamedFreezeLock(String docTag, String domainTag, String lockName)` Apply a named freeze (also known as legal hold) lock to a document.
`void`	`applySingletonLock(AttributeValueTable avt)` Applies a singleton LockEntry to a PublicObject The keys supported by this operation: TAG: the tag that identifies the LockEntry applied LOCKTYPEKEY: the lock type key PUBLICOBJECT: the tag that identifies the PublicObject that will receive the LockEntry CUSTOM: whether the lock type is custom LOCKALLITEMS: whether to recursively lock all items if the specified PublicObject is a Folder
`void`	`assignClassDomain(AttributeValueTable avt)` Assigns a ClassDomain to an Attribute.
`void`	`assignLifecyclePolicyByCategory(String lpTag, String className)` Assign the specified LifecyclePolicy to all documents not yet assigned to a LifecyclePolicy and that have at least one instance of the category specified.
`void`	`assignValueDefault(AttributeValueTable avt)` Assigns a ValueDefault to an Attribute.
`void`	`assignValueDomain(AttributeValueTable avt)` Assigns a ValueDomain to an Attribute.
`void`	`beginTransaction(String trantag)` Begin an outer transaction.
`protected boolean`	`businessObjectExists(String tag)` Check whether a BusinessObject has been registered for the specified tag.
`void`	`clearImpersonateUser()` Clears impersonation for the current session.
`void`	`clearSharedCaches()` Explicitly clear the shared data caches.
`void`	`cloneCurrentSession(AttributeValueTable avt)` Clone the current session.
`protected LibraryObjectDefinition`	`cloneDefinition(LibrarySession sess, String sourceDefTag, String cloneDefTag)` Clone a LibraryObjectDefinition by the specified source tag.
`void`	`cloneDefinition(String cloneDefTag, String sourceDefTag)` Clone a definition object, useful when the source is readonly and further mutations are necessary.
`void`	`comment()` Show a comment in the output.
`void`	`comment(String message)` Show a comment in the output.
`void`	`compareObjects(String obj1Tag, String obj2Tag)` Compare two objects, reporting whether or not they are the same.
`void`	`completeTransaction(String trantag)` Complete an outer transaction.
`void`	`concatenateObjectId(String varName, String tag)` Store the the object ID value as a String to be used as a substitution variable.
`void`	`concatenateStrings(String varName, String s1)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2, String s3)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2, String s3, String s4)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2, String s3, String s4, String s5)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2, String s3, String s4, String s5, String s6)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateStrings(String varName, String s1, String s2, String s3, String s4, String s5, String s6, String s7)` Concatenate strings, and store the result for use as a substitution variable
`void`	`concatenateToLowerStrings(String varName, String s1)` Concatenate strings, forced to lower case, and store the result for use as a substitution variable
`void`	`concatenateToLowerStrings(String varName, String s1, String s2)` Concatenate strings, forced to lower case, and store the result for use as a substitution variable
`void`	`concatenateToLowerStrings(String varName, String s1, String s2, String s3)` Concatenate strings, forced to lower case, and store the result for use as a substitution variable
`void`	`concatenateToUpperStrings(String varName, String s1)` Concatenate strings, forced to upper case, and store the result for use as a substitution variable
`void`	`concatenateToUpperStrings(String varName, String s1, String s2)` Concatenate strings, forced to upper case, and store the result for use as a substitution variable
`void`	`concatenateToUpperStrings(String varName, String s1, String s2, String s3)` Concatenate strings, forced to upper case, and store the result for use as a substitution variable
`protected LibrarySession`	`connect(Credential credential, ConnectOptions options)` Create a LibrarySession.
`protected LibrarySession`	`connect(String username, String password, String server)` Create a LibrarySession.
`protected AuditEvent`	`constructAuditEvent(LibraryObject target, String opTypeKey, String domainTag, String auxString, String auxNumber, String auxObjsToken)` Construct an audit event, to be posted as either a Custom or System AuditEvent.
`protected PreparedSelectorGenerator`	`constructPreparedSelectorGenerator()` Return a newly constructed instance of a PreparedSelectorGenerator.
`protected PreparedSelectorGenerator`	`constructPreparedSelectorGenerator(String psGenClassName)` Return a newly constructed instance of a PreparedSelectorGenerator, of the specified class.
`protected Hashtable`	`convertPropertyDefinitionsToHashtable(PropertyDefinition[] pbDefs)` Convert an array of PropertyDefinitions to a Hashtable, keyed by the property name, with the value being an AttributeValue representation of the property's value.
`void`	`convertStringArray(AttributeValueTable avt, String key)` Convert the String array that may be in the specified table using the old array token syntax.
`protected Boolean`	`convertToBoolean(LibrarySession sess, String boolVal)` Convert a numeric String representation to a Boolean.
`protected boolean`	`convertToBoolean(LibrarySession sess, String boolVal, boolean defVal)` Convert a numeric String representation to a boolean, using the specified default value if the string is null.
`protected Double`	`convertToDouble(LibrarySession sess, String doubleVal)` Convert a numeric String representation to a Double.
`protected double`	`convertToDouble(LibrarySession sess, String doubleVal, double defVal)` Convert a numeric String representation to a double, using the specified default value if the string is null.
`protected Integer`	`convertToInteger(LibrarySession sess, String intVal)` Convert a numeric String representation to an integer.
`protected int`	`convertToInteger(LibrarySession sess, String intVal, int defVal)` Convert a numeric String representation to an integer, using the specified default value if the string is null.
`protected Long`	`convertToLong(LibrarySession sess, String longVal)` Convert a numeric String representation to a long.
`protected long`	`convertToLong(LibrarySession sess, String longVal, long defVal)` Convert a numeric String representation to a long, using the specified default value if the string is null.
`protected String`	`convertToRelativePath(LibrarySession sess, String absPath)` Convert an absolute path to a relative path, by stripping off the leading delimiter.
`void`	`copy(AttributeValueTable avt)` Copies the specified PublicObject.
`void`	`create(String objectTag, String defTag)` Create a LibraryObject from the specified definition.
`void`	`createAccessControlList(AttributeValueTable avt)` Creates an AccessControlList.
`void`	`createAndApplyAuditTypeList(String specTag, String atlDefTag)` Creates an audit type list.
`void`	`createApplicationToken(AttributeValueTable avt)` Creates a ApplicationToken.
`void`	`createApplicationToken(String tokenTag, String tokenDefTag)` Create a ApplicationToken.
`void`	`createAuditSpecification(AttributeValueTable avt)` Creates a new AuditSpecification.
`void`	`createAuditSpecification(String objectTag, String defTag)` Creates an AuditSpecification using the supplied definition.
`void`	`createAuditSpecification(String specName, String atlDefTag, String atsDefTag, String ahsDefTag, String specDesc)` Creates a new AuditSpecification.
`void`	`createAuditSpecification(String specName, String atlDefTag, String atsDefTag, String ahsDefTag, String specDesc, String userSearch)` Creates a new AuditSpecification.
`void`	`createAuditTypeList(AttributeValueTable avt)` Creates an audit type list.
`void`	`createAuditTypeList(String atlTag, String atlDefTag)` Creates an audit type list.
`void`	`createAutoFolderingActionSpecification(AttributeValueTable avt)` Creates a new AutoFolderingActionSpecification entirely, using embeeded definitions.
`void`	`createAutoFolderingActionSpecification(String specTag, String defTag)` Create a AutoFolderingActionSpecification.
`void`	`createCategorizedDocument(String docTag, String parentTag, String docName, String contentFileName, String catDefTag)` Create a document with a category, as specified by a category defintiion tag.
`void`	`createClassDomain(AttributeValueTable avt)` Creates a ClassDomain.
`void`	`createClassObject(AttributeValueTable avt)` Creates a ClassObject.
`protected ClassObject`	`createClassObject(String className)` Creates a ClassObject from previously created definitions.
`void`	`createCustomLockEntry(AttributeValueTable avt)` Applies a custom LockEntry on a PublicObject The keys supported by this operation: TAG: the tag that identifies the newly created LockEntry CUSTOMLOCKTYPEKEY: the custom lock type key for the new LockEntryDefinition PUBLICOBJECT: the tag that identifies the PublicObject that will receive the new custom LockEntry
`void`	`createCustomMediaDriverSpecification(AttributeValueTable avt)` Creates a new CustomMediaDriverSpecification entirely, using embeeded definitions.
`void`	`createCustomMediaDriverSpecification(String cmdsTag, String defTag)` Creates a CustomMediaDriverSpecification.
`LibraryObjectDefinition`	`createDefinition(String defTag, String className)` Create a definition object, and identify it for subsequent use.
`void`	`createDefinitionFromDefinitionObject(String defTag, String defobjTag)` Create a LibraryObjectDefinition from a DefinitionObject.
`void`	`createDefinitionFromObject(String defTag, String objTag)` Create a LibraryObjectDefinition from a LibraryObject.
`void`	`createDefinitionObject(String defobjTag, String defTag)` Create a DefinitionObject.
`void`	`createDependentView(AttributeValueTable avt)` Creates a DependentView.
`void`	`createDocument(AttributeValueTable avt)` Creates a Document.
`void`	`createDocument(String docTag, String parentTag, String docDefTag)` Create a document, using a DocumentDefintion.
`void`	`createDocument(String docTag, String parentTag, String docName, String defTag)` Create a document.
`void`	`createDocumentBatch(AttributeValueTable avt)` Creation a batch of Documents from an input file directory.
`protected int`	`createDocuments(String dirPath, Folder topFolder, AccessControlList acl, Format format, Media media)` Produce a list of files found under the specified absolute directory path.
`void`	`createEntireAuditSpecification(AttributeValueTable avt)` Creates a new AuditSpecification entirely, using embeeded definitions for the AuditTypeList, AuditTargetSpecification, and AuditHandlerSpecification.
`void`	`createExtendedPermission(AttributeValueTable avt)` Creates an ExtendedPermission.
`void`	`createExtendedUserProfile(AttributeValueTable avt)` Creates an ExtendedUserProfile.
`void`	`createFolder(AttributeValueTable avt)` Creates a Folder.
`void`	`createFolder(String folderTag, String parentTag, String folderName)` Create a new folder.
`void`	`createFolder(String folderTag, String parentTag, String folderName, String defTag)` Create a new folder.
`void`	`createFolderLink(AttributeValueTable avt)` Creates a FolderLink.
`void`	`createFolderTree(AttributeValueTable avt)` Creates a folder tree for all folders missing in the specified absolute path.
`void`	`createFormat(AttributeValueTable avt)` Creates a Format.
`void`	`createGroup(AttributeValueTable avt)` Creates a DirectoryGroup.
`void`	`createGuestSession(String sesstag)` Create a new session for the "guest" user.
`void`	`createLibraryObject(AttributeValueTable avt)` Creates a LibraryObject.
`protected LibraryObject`	`createLibraryObject(AttributeValueTable avt, LibraryObjectDefinition def, LibraryObject existingObj)` Creates a new LibraryObject entirely, using embeeded definitions.
`void`	`createLifecycleDateRuleSpecification(AttributeValueTable avt)` Creates a LifecycleDateRuleSpecification.
`void`	`createLifecycleDateRuleSpecification(String specTag, String defTag)` Create a LifecycleDateRuleSpecification.
`void`	`createLifecyclePolicy(AttributeValueTable avt)` Creates a LifecyclePolicyActionSpecification.
`void`	`createLifecyclePolicy(String lpTag, String defTag)` Create a LifecyclePolicy.
`void`	`createLifecyclePolicyActionSpecification(AttributeValueTable avt)` Creates a LifecyclePolicyActionSpecification.
`void`	`createLifecyclePolicyActionSpecification(String specTag, String defTag)` Create a LifecyclePolicyActionSpecification.
`void`	`createLifecyclePolicyEntryDefinition(String defTag, String lpeName, String lpeDesc, String actionTag, String timePeriod, String execPeriod, String execBaseTime)` Create and register a LifecyclePolicyEntry definition.
`void`	`createLink(AttributeValueTable avt)` Creates a Link.
`void`	`createLink(String linkTag, String parentTag, String defTag)` Creates a link using a LinkDefinition.
`void`	`createLink(String linkTag, String parentTag, String name, String assocTag)` Creates a link.
`void`	`createLockTypeLookupTables()` Creates the lock type lookup tables in the instance-wide Domain PropertyBundle.
`void`	`createMedia(AttributeValueTable avt)` Creates a Media.
`void`	`createMedia(String mediaTag, String defTag)` Creates a Media.
`void`	`createNamedFreezeLock(String domainTag, String lockName)` Create a named freeze (also known as legal hold) lock.
`void`	`createNamedPropertyBundle(AttributeValueTable avt)` Creates a Named PropertyBundle.
`void`	`createNodeConfiguration(AttributeValueTable avt)` Creates a NodeConfiguration.
`void`	`createNodeConfiguration(String tag, String name, String ncSuperTag, String active, String defTag)` Create a NodeConfiguration.
`void`	`createOperationActionSpecification(AttributeValueTable avt)` Creates a new OperationActionSpecification entirely, using embeeded definitions.
`void`	`createOperationActionSpecification(String specTag, String defTag)` Create a OperationActionSpecification.
`void`	`createOrUpdateClassObject(AttributeValueTable avt)` Creates or updates a ClassObject.
`void`	`createPermissionBundle(AttributeValueTable avt)` Creates a PermissionBundle.
`void`	`createPolicy(AttributeValueTable avt)` Creates a Policy.
`void`	`createPolicyList(AttributeValueTable avt)` Creates a PolicyList.
`void`	`createPropertyBundle(AttributeValueTable avt)` Creates a regular PropertyBundle.
`void`	`createQueue(AttributeValueTable avt)` Creates a Queue.
`void`	`createRetentionPolicy(String rpTag, String defTag)` Create a RetentionPolicy.
`void`	`createServerConfiguration(AttributeValueTable avt)` Create a ServerConfiguration.
`void`	`createServerConfiguration(String tag, String name, String likeTag, String defTag)` Create a ServerConfiguration.
`void`	`createServerSpecification(AttributeValueTable avt)` Creates a new ServerSpecification entirely, using embeeded definitions.
`void`	`createServiceConfiguration(AttributeValueTable avt)` Create a ServiceConfiguration.
`void`	`createServiceConfiguration(String tag, String name, String likeTag, String defTag)` Create a ServiceConfiguration.
`void`	`createSession(String sesstag, String username)` Register a session.
`void`	`createSession(String sesstag, String username, String password)` Register a session.
`void`	`createSimplePropertyTable(AttributeValueTable avt)` Creates a SimplePropertyTable.
`void`	`createSimplePropertyTableList(AttributeValueTable avt)` Creates a SimplePropertyTableList.
`void`	`createStorageGroup(AttributeValueTable avt)` Creates a StorageGroup.
`void`	`createStorageGroup(String sgTag, String defTag)` Creates a StorageGroup.
`void`	`createSystemLockObject(AttributeValueTable avt)` Creates a SystemLockObject.
`void`	`createUser(AttributeValueTable avt)` Creates a User.
`void`	`createUserSession(String sesstag, String userName)` Create a new session for a user, from the current adin-mode session.
`void`	`createValueDefault(AttributeValueTable avt)` Creates a ValueDefault.
`void`	`createValueDomain(AttributeValueTable avt)` Creates a ValueDomain.
`void`	`deactivateAuditHandlerSpecification(String specName)` Sets an AuditSpecificationHandler to an inactive state.
`void`	`deactivateAuditSpecification(String specName)` Sets an AuditSpecification to an inactive state.
`void`	`deactivateOperationActionSpecification(String tagOrName)` Deactivate a OperationActionSpecification.
`void`	`deactivateServerSpecification(String specName)` Sets an ServerSpecification to an inactive state.
`void`	`deactivateSystemObject(String objectTag)` Deactivate a SystemObject.
`void`	`deactivateUnknownOperationActionSpecifications()` Deactivate all active OperationActionSpecification instances whose associated OperationAction class is not constructable.
`void`	`defineAttribute(AttributeValueTable avt)` Defines an Attribute definition.
`void`	`defineAuditHandlerSpecificationDefinition(String defTag, String handlerClass, String timerPeriod, String timerBaseTime, String notifiedOnEvent)` Defines an AuditHandlerSpecification definition.
`void`	`defineAuditHandlerSpecificationDefinition(String defTag, String handlerClass, String timerPeriod, String timerBaseTime, String notifiedOnEvent, String handlerType, String rtClassif)` Defines an AuditHandlerSpecification definition.
`void`	`defineAuditTargetSpecificationDefinition(String defTag, String target, String descendOpt)` Defines an AuditTargetSpecification definition.
`void`	`defineAuditTypeListDefinition(String defTag)` Creates an unnamed AuditTypeList definition.
`void`	`defineAuditTypeListDefinition(String defTag, String name)` Creates an AuditTypeList definition, with an optional name.
`void`	`defineClassObject(AttributeValueTable avt)` Defines a ClassObject definition.
`void`	`defineExistingClassObject(AttributeValueTable avt)` Defines a definition for an existing ClassObject, for subsequent update.
`protected boolean`	`definitionExists(String tag)` Check whether a definition has been registered for the specified tag.
`void`	`deleteAllCategories(String className)` Deletes all Category instances for the specified Category.
`void`	`deleteAuditSpecification(String specName)` Deletes an AuditSpecification.
`void`	`deleteNamedFreezeLock(String domainTag, String lockName)` Delete a named freeze (also known as legal hold) lock.
`void`	`deleteRepositoryParameter(AttributeValueTable avt)` Deletes a repository parameter.
`void`	`deleteUser(AttributeValueTable avt)` Deletes a User.
`protected void`	`deregisterBusinessObject(String tag)` De-register a BusinessObject by name.
`void`	`deregisterCustomLockType(AttributeValueTable avt)` De-Registers a custom LockeEntry type from the locktype lookup table.
`void`	`deregisterDefinition(String tag)` De-register a LibraryObjectDefinition by name.
`void`	`deregisterLockType(AttributeValueTable avt)` De-Registers a custom LockEntry type from the locktype lookup table.
`protected void`	`deregisterObject(String tag)` De-register a LibraryObject by name.
`protected void`	`deregisterSession(String tag, LibrarySession sess)` De-register a session.
`protected Transaction`	`deregisterTransaction(String trantag)` De-register a transaction.
`protected String`	`determinePrimaryObjectColumnAlias(PreparedSelector sel)` Determine the column alias that is defined for the entire object corresponding to the Primary search target, if any.
`protected void`	`ensureFreed(LibraryObject obj)` Ensure that the specified object is freed.
`void`	`executeAutocommitSql(AttributeValueTable avt)` Executes a SQL statement that will be auto-committed.
`void`	`executePreparedSelect(AttributeValueTable avt)` Execute a PreparedSelector, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelect(String priTargetTag, String auxTargetsTag, String condition, String sortCondition, String maxCountValue)` Execute a PreparedSelector, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelect(String priTargetTag, String auxTargetsTag, String condition, String sortCondition, String maxCountValue, String startAtValue, String distinctValue, String stmtKey)` Execute a PreparedSelector, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelect(String priTargetTag, String auxTargetsTag, String condition, String sortCondition, String maxCountValue, String startAtValue, String distinctValue, String stmtKey, String verbose)` Execute a PreparedSelector, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelectCount(AttributeValueTable avt)` Execute a PreparedSelector to get a search count, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelectCount(String priTargetTag, String auxTargetsTag, String condition)` Execute a PreparedSelector to get a search count, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelectCount(String priTargetTag, String auxTargetsTag, String condition, String distinctValue, String stmtKey)` Execute a PreparedSelector to get a search count, using a search condition that may leverage convenience functions used to generate the correct SQL.
`void`	`executePreparedSelectFromJson(AttributeValueTable avt)` Execute a PreparedSelector, using a search defintion stored as JSON in a Document.
`void`	`executePreparedSelectResults(AttributeValueTable avt)` Execute a PreparedSelector, using PreparedSelectorGenerator, selecting specific columns from the search targets.
`void`	`exists(String path)` Shows whether or not an absolute path refers to an object.
`void`	`existsRelative(String folderTag, String path)` Shows whether or not a relative path refers to an object.
`void`	`extractContentForIndexing()` Extract content for indirect text indexing.
`void`	`findOrCreateCompositeGroup(AttributeValueTable avt)` Find or create a CompositeGroup.
`void`	`freeClassDomain(AttributeValueTable avt)` Frees a ClassDomain.
`void`	`freeClassObject(AttributeValueTable avt)` Frees a ClassObject.
`void`	`freeExtendedPermission(AttributeValueTable avt)` Frees a ExtendedPermission.
`void`	`freeFolder(AttributeValueTable avt)` Frees a Folder.
`void`	`freeFormat(AttributeValueTable avt)` Frees a Format.
`void`	`freeNamedPropertyBundle(AttributeValueTable avt)` Frees a Named PropertyBundle.
`void`	`freeNamedPropertyBundle(String name)` Frees a Named PropertyBundle.
`void`	`freeNodeConfiguration(AttributeValueTable avt)` Free a NodeConfiguration.
`void`	`freeNodeConfiguration(String ncTag)` Free a NodeConfiguration.
`void`	`freeObject(String objectTag)` Free an object.
`void`	`freePermissionBundle(AttributeValueTable avt)` Frees a PermissionBundle.
`void`	`freePolicy(AttributeValueTable avt)` Frees a Policy.
`void`	`freeServerConfiguration(AttributeValueTable avt)` Free a ServerConfiguration.
`void`	`freeServerConfiguration(String scTag)` Free a ServerConfiguration.
`void`	`freeServiceConfiguration(AttributeValueTable avt)` Free a ServiceConfiguration.
`void`	`freeServiceConfiguration(String svcTag)` Free a ServiceConfiguration.
`void`	`freeUnreferencedContent(String batchValue)` Free unreferenced ContentObjects.
`void`	`freeValueDefault(AttributeValueTable avt)` Frees a ValueDefault.
`void`	`freeValueDomain(AttributeValueTable avt)` Frees a ValueDomain.
`protected String`	`generateClassObjectDefinitionTag(String className)` Generate the tag name used for the ClassObjectDefinition used to create or update a ClassObject and its Attributes.
`String`	`getAbsolutePath(String paramName, String relativePath)` Get the absolute path for the specified subpath relative to the directory mapped by the specified parameter name.
`protected AttributeValue`	`getAclValueForConfigurationObjects(LibrarySession sess)` Get the ACL value to use for Configuration object creation.
`AttributeValue`	`getAttributeValue(AttributeValueTable avt)` Derives an AttributeValue from entries in the specified AttributeValueTable.
`AttributeValue`	`getAttributeValue(AttributeValueTable avt, String keyArgName)` Derives an AttributeValue from entries in the specified AttributeValueTable.
`AttributeValue`	`getAttributeValue(AttributeValueTable avt, String[] keyArgNames)` Derives an AttributeValue from entries in the specified AttributeValueTable.
`AuditDriverHelper`	`getAuditDriverHelper()` Return the AuditDriverHelper in use.
`protected AuditEventDispatcher`	`getAuditEventDispatcher(LibrarySession sess)` Get the AuditEventDispatcher.
`protected long`	`getAuditingStartingId()` Get the value previously set as the starting point for Audit searches.
`protected AttributeValue[]`	`getAuxiliaryTargets(String[] rawAuxTargs)` Gets the Auxiliary Targets from an array of target strings.
`protected AttributeValue[]`	`getBindValues(List<AttributeValueTable> bindValueList)` Gets the bind values defined in the specified table list.
`protected String[]`	`getBypassSecurityAliases(String[] bypassSecAliases)` Gets the Bypass Security aliases from the specified set of aliases that should not have security clauses generated.
`protected int`	`getClassObjectCreationMode()` Gets the mode for scripts that create ClassObjects.
`String`	`getConsoleInputBoolean(String varName, String prompt, String defValue, String skipIfSet, String required)` Get a boolean input string from the console, and store the result back into the ParameterTable.
`String`	`getConsoleInputString(AttributeValueTable avt)` Get input string from the console, and store the result back into the ParameterTable.
`String`	`getConsoleInputString(String varName, String prompt, String defValue, String skipIfSetVal, String requiredVal)` Get input string from the console, and store the result back into the ParameterTable.
`String`	`getConsoleInputString(String varName, String prompt, String defValue, String skipIfSet, String required, String entrySecure)` Get input string from the console, and store the result back into the ParameterTable.
`String`	`getConsoleSecureInputString(String varName, String prompt, String defValue, String skipIfSetVal, String requiredVal)` Get input string from the console, and store the result back into the ParameterTable.
`String`	`getContentPath(String path)` Get the absolute path for the specified path that is relative to IFSROOT.
`protected LibrarySession`	`getCurrentSession()` Get the current session.
`ScriptDriver`	`getDriver()` Return the script driver used to construct this instance.
`void`	`getIncludedFileSettings(String inclFileName)` Include settings in the specified file into the current ParameterTable.
`PrintWriter`	`getLogWriter()` Return the log writer in use.
`ScriptOperations.ServerDefinition[]`	`getManagedServerDeclarations()` Gets the managed Server declarations previously added via `addManagedServerDeclaration`.
`ScriptOperations.ServiceDefinition[]`	`getManagedServiceDeclarations()` Gets the managed Service declarations previously added via `addManagedServiceDeclaration`.
`ParameterTable`	`getParameterTable()` Returns the ParameterTable used by this instance.
`protected LibraryObject[]`	`getSavedSearchResultPrimaryObjects(String tag)` Gets the search results when Primary target's objects were selected.
`protected AttributeValueTable[]`	`getSavedSearchResults(String tag)` Gets the search results when multiple columns were selected.
`boolean`	`getShowDates()` Return indication as to whether dates should be shown in the output.
`String[]`	`getStringArray(AttributeValueTable avt, String key)` Get String array from the specified table and key.
`protected String[]`	`getStringsFromArrayToken(String token)` Get String array from a value of the form "{value1, value2, value3}".
`boolean`	`getStripNumbersFromAuditEventProperties()` Return indication as to whether numbers should be replaced in audit event properties in `ShowUtils.showAuditEvents`.
`void`	`handleEventPostedForCustomAuditHistory(String specTag)` Initialize and post a "event posted" notification for a custom AuditSpecification.
`void`	`handleTimerExpiredForCustomAuditHistory(String specTag)` Initialize and post a "timer expired" notification for a custom AuditSpecification.
`void`	`identifyAcl(AttributeValueTable avt)` Identify an AccessControlList by name and optionally class.
`void`	`identifyAcl(String aclTag, String objectTag)` Identify an ACL using another PublicObject.
`void`	`identifyApplicationToken(String tokenTag, String tokenValue)` Lookup and identify a ApplicationToken by the object's token value.
`void`	`identifyAttribute(String tag, String className, String attrName)` Identify an Attribute of a ClassObject.
`void`	`identifyAttributePropertyBundle(String tag, String className, String attrName)` Identify an Attribute' Property Bundle.
`void`	`identifyAuditHandlerSpecification(String tag, String specName)` Identify an audit handler specification by the AuditSpecification name.
`void`	`identifyAuditSpecification(String tag, String asName)` Identify an audit specification by name.
`void`	`identifyAuditTargetSpecification(String tag, String specName)` Identify an audit target specification by the AuditSpecification name.
`void`	`identifyAuditTypeList(String tag, String atlName)` Identify an audit type list by name.
`void`	`identifyAuditTypeListBySpecification(String tag, String specName)` Identify an AuditTypeList by the AuditSpecification name.
`void`	`identifyAutoFolderingActionSpecification(String specTag, String specName)` Identify a AutoFolderingActionSpecification by its unique name.
`void`	`identifyByAttribute(String identifiedTag, String objectTag, String attrName)` Identify an object as an attribute of another object.
`void`	`identifyByPath(String objectTag, String path)` Lookup an object by the specified path, and allow it to be subsequently identified by the specified object tag.
`void`	`identifyByRelativePath(String objectTag, String parentTag, String relativePath)` Lookup an object found under the specified parent folder and relative path, and allow it to be subsequently identified by the specified object tag.
`void`	`identifyCategory(AttributeValueTable avt)` Identify a Category by its class name and/or instance name.
`void`	`identifyCategory(String catTag, String poTag, String catClass, String catName)` Identify a Category for a specified PublicObject.
`void`	`identifyClassAcl(String aclTag, String aclName)` Identify a Class ACL by name.
`void`	`identifyClassDomain(String tag, String name)` Identify a ClassDomain.
`void`	`identifyClassObject(String tag, String name)` Identify a ClassObject.
`void`	`identifyClassPolicyBundle(String tag, String className)` Identify a ClassObject's Policy bundle.
`void`	`identifyClassPropertyBundle(String tag, String className)` Identify a ClassObject's property bundle.
`void`	`identifyCompositeGroup(AttributeValueTable avt)` Identify a CompositeGroup by its membership.
`void`	`identifyCustomLock(String leTag, String poTag)` Identify a custom LockEntry by PublicObject.
`void`	`identifyCustomMediaDriverSpecification(String cmdsTag, String cmdsName)` Identifies a CustomMediaDriverSpecification by its unique name.
`void`	`identifyDependentView(String dvTag, String name)` Identifies a DependentView by its unique name.
`void`	`identifyExtendedPermission(String tag, String name)` Identify a ExtendedPermission.
`void`	`identifyFormat(String formatTag, String formatName)` Identifies a Format by its unique name.
`void`	`identifyGlobalAuditSpecification(String tag)` Identify the Global Audit History audit specification.
`void`	`identifyGlobalAuditTypeList(String atlTag)` Identifies the AuditTypeList used for global audit history.
`void`	`identifyGroup(AttributeValueTable avt)` Identify a Group by name and optionally class.
`void`	`identifyGuestUser(String guestTag)` Lookup the GUEST user and register it.
`void`	`identifyInstancePropertyBundle(String pbTag)` Identify the "Instance PropertyBundle", also known as the Domain PropertyBundle.
`void`	`identifyLibraryObject(AttributeValueTable avt)` Identify a LibraryObject by the specified search condition.
`void`	`identifyLifecycleDateRuleSpecification(String specTag, String specName)` Identify a LifecycleDateRuleSpecification by its unique name.
`void`	`identifyLifecyclePolicy(String lpTag, String lpName)` Identify a LifecyclePolicy by its unique name.
`void`	`identifyLifecyclePolicyActionSpecification(String specTag, String specName)` Identify a LifecyclePolicyActionSpecification by its unique name.
`void`	`identifyLifecyclePolicyEntry(String lpeTag, String lpTag, String lpeSeq)` Identify a LifecyclePolicyEntry by its parent LifecyclePolicy and its sequence within that LifecyclePolicy.
`void`	`identifyMedia(String mediaTag, String mediaName)` Identifies a Media by its unique name.
`void`	`identifyMessageEntry(AttributeValueTable avt)` Identify a MessageEntry for a PublicObject that has an ActivityRecord.
`void`	`identifyMessageList(AttributeValueTable avt)` Identify a MessageList for a PublicObject that has an ActivityRecord.
`void`	`identifyNamedFreezeLock(String sleTag, String domainTag, String lockName)` Identify a named freeze (also known as legal hold) lock from its name.
`void`	`identifyNamedPropertyBundle(String tag, String name)` Identify a Named PropertyBundle.
`void`	`identifyNodeConfiguration(String ncTag, String ncName)` Identify a NodeConfiguration by its unique name.
`void`	`identifyObjectAuditSpecification(String tag)` Identify the Object Audit History audit specification.
`void`	`identifyObjectProperty(AttributeValueTable avt)` Identifies an object Property on an identified PropertyBundle.
`void`	`identifyOperationActionSpecification(String specTag, String specName)` Identify a OperationActionSpecification by its unique name.
`void`	`identifyPermissionBundle(String tag, String name)` Identify a PermissionBundle.
`void`	`identifyPolicy(String tag, String name)` Identify a Policy.
`void`	`identifyPolicyList(String tag, String name)` Identify a PolicyList.
`void`	`identifyPrimaryUserProfile(String pupTag, String userName)` Identify the PrimaryUserProfile for a user.
`void`	`identifyPropertyBundle(AttributeValueTable avt)` Identify a PropertyBundle as the bundle used by a previously identified LibraryObject.
`void`	`identifyQueue(String quTag, String quName)` Identify a Queue by name.
`void`	`identifyQueueTypeMapBundle(String pbTag, String quName)` Identify the PropertyBundle used by a Queue to map message types.
`void`	`identifyRetentionPolicy(String rpTag, String rpName)` Identify a RetentionPolicy by its unique name.
`void`	`identifyServerConfiguration(String scTag, String scName)` Identify a ServerConfiguration by its unique name.
`void`	`identifyServerSpecification(String specTag, String specName)` Identify a ServerSpecification by its unique name.
`void`	`identifyServiceConfiguration(String scTag, String scName)` Identify a ServiceConfiguration by its unique name.
`void`	`identifySingletonLockType(AttributeValueTable avt)` Applies a singleton LockEntry to a PublicObject The keys supported by this operation: TAG: the tag that identifies the LockEntry applied LOCKTYPEKEY: the lock type key PUBLICOBJECT: the tag that identifies the PublicObject that will receive the LockEntry CUSTOM: whether the lock type is custom
`void`	`identifyStorageGroup(String sgTag, String sgName)` Identifies a StorageGroup by its unique name.
`void`	`identifySystemAcl(String aclTag, String aclName)` Identify a System ACL by name.
`void`	`identifySystemLockObject(String sloTag, String sloName)` Identify a SystemLockObject by name.
`void`	`identifySystemUser(String sysTag)` Lookup the SYSTEM user and register it.
`void`	`identifyUser(String userTag, String userName)` Lookup a user by name and register it.
`void`	`identifyValueDefault(String tag, String name)` Identify a ValueDefault.
`void`	`identifyValueDomain(String tag, String name)` Identify a ValueDomain.
`void`	`identifyWorldGroup(String worldTag)` Lookup the "WORLD" group and register it.
`void`	`impersonateUser()` Clears impersonation for the current session.
`void`	`impersonateUser(String userName)` Impersonates another user for the current session.
`void`	`initializeManualTextIndexingRetainedEvents(AttributeValueTable avt)` Initializes handling of ManualTextIndexingRetainedEvents.
`protected boolean`	`isBootstrapModeEnabled()` Gets whether the mode for scripts that create ClassObjects is in bootstrap mode.
`protected boolean`	`isDomainScopeImpliedForSearch()` Returns indication as to whether a Domain ID scoping is implied for Audit searches.
`protected boolean`	`isInArray(LibraryObject obj, LibraryObject[] objs)` Check if the specified object is in the specified array.
`void`	`log()` Writes an empty line to the log.
`void`	`log(String message)` Writes a message to the log file.
`protected AccessControlList`	`lookupAcl(LibrarySession sess, String tagOrName)` Lookup an ACL by the specified tag or name.
`protected ApplicationToken`	`lookupApplicationToken(LibrarySession sess, String tkValue)` Lookup a ApplicationToken by the specified token value.
`protected Folder`	`lookupAuditDomainContext(LibrarySession sess, String tag)` Lookup the Audit Domain context by Tag.
`protected AuditSpecification`	`lookupAuditSpecification(LibrarySession sess, String tagOrName)` Lookup a AuditSpecification by the specified name.
`protected AutoFolderingActionSpecification`	`lookupAutoFolderingActionSpecification(String tagOrName)` Lookup an AutoFolderingActionSpecification by tag or name.
`protected Object`	`lookupBusinessObject(LibrarySession session, String tag)` Lookup a BusinessObject by the specified tag.
`protected Hashtable`	`lookupBusinessObjectHashtable(String key)` Find or add a Hashtable as a business object.
`protected List`	`lookupBusinessObjectList(String key)` Find or add a List as a business object.
`protected ClassAccessControlList`	`lookupClassAcl(LibrarySession sess, String aclName)` Lookup a Class ACL by name.
`protected int`	`lookupDatatype(String stype)` Convert a data type string to an integer data type, as defined in `oracle.ifs.beans.Attribute`.
`protected String`	`lookupDatatypeString(int type)` Convert a data type integer to a String representation.
`protected LibraryObjectDefinition`	`lookupDefinition(LibrarySession sess, String tag)` Lookup a LibraryObjectDefinition by the specified tag.
`protected LibraryObjectDefinition`	`lookupDefinition(LibrarySession sess, String tag, String className)` Lookup a LibraryObjectDefinition by the specified tag and that is the appropriate instance for the specified classobject name.
`protected DirectoryObject`	`lookupDirectoryObject(LibrarySession sess, String tagOrName)` Lookup a DirectoryObject (user or group) by the specified name.
`protected Document`	`lookupDocument(LibrarySession sess, String tag)` Lookup a Document by the specified tag.
`protected Folder`	`lookupFolder(LibrarySession sess, String tag)` Lookup a Folder by the specified tag.
`protected Format`	`lookupFormat(LibrarySession sess, String tagOrName)` Lookup a Format by the specified name.
`protected Format`	`lookupFormatFromCollection(LibrarySession sess, String name)` Lookup a Format by the specified name, using the Format Collection.
`protected DirectoryGroup`	`lookupGroup(LibrarySession sess, String tag)` Lookup a DirectoryGroup by the specified tag.
`protected Media`	`lookupMedia(LibrarySession sess, String tagOrName)` Lookup a Media by the specified tag or Media name.
`protected MessageEntry`	`lookupMessageEntry(LibrarySession sess, String tag)` Lookup a MessageEntry by the specified tag.
`protected LibraryObject`	`lookupObject(LibrarySession sess, String tag)` Lookup a LibraryObject by the specified tag.
`protected LibraryObject`	`lookupObject(LibrarySession sess, String tag, String className)` Lookup a LibraryObject by the specified tag and that is an instance of the specified class.
`AttributeValue`	`lookupObjectAttributeValue(String tag)` Lookup an AttributeValue that identifies a LibraryObject, by the specified tag.
`protected Long`	`lookupObjectId(LibrarySession sess, String tag)` Lookup a LibraryObject's ID by the specified tag.
`protected OperationActionSpecification`	`lookupOperationActionSpecification(String tagOrName)` Lookup an OperationActionSpecification by tag or name.
`protected PublicObject`	`lookupPublicObject(LibrarySession sess, String tag)` Lookup a PublicObject by the specified tag.
`protected Queue`	`lookupQueue(LibrarySession sess, String quName)` Lookup a Queue by name.
`protected LibrarySession`	`lookupSessionByTag(String tag)` Lookup a session by the session tag that was used to register it.
`protected SystemAccessControlList`	`lookupSystemAcl(LibrarySession sess, String aclName)` Lookup a System ACL by name.
`protected SystemLockObject`	`lookupSystemLockObject(LibrarySession sess, String sloName)` Lookup a SystemLockObject by name.
`protected String`	`lookupTagBySessionId(Long sessid)` Lookup a session tag by the session ID.
`protected DirectoryUser`	`lookupUser(LibrarySession sess, String tagOrName)` Lookup a DirectoryUser by the specified name or tag.
`protected DirectoryUser`	`lookupUserFromCollection(LibrarySession sess, String userName)` Lookup a user by the specified name.
`void`	`makeDefinitionReadOnly(String defTag)` Make a definition readonly, so that it can be used in multiple operations.
`void`	`markCurrentAuditingId()` Mark the starting point for subsequent audit event searches.
`protected void`	`modifyClassObject(ClassObject co, String className, boolean removeAttrs, boolean verbose)` Modifies the specified ClassObject to match the previously created definitions.
`void`	`move(AttributeValueTable avt)` Move the specified PublicObject to a new folder.
`void`	`moveCategory(AttributeValueTable avt)` Move the specified Category to become associated with a new PublicObject.
`protected String`	`normalizeBooleanString(String rawValue)` Convert the specified string to "true", "false", or null.
`void`	`notifyCustomAuditHistoryHandler(String specTag, String notifyType)` Initialize and post a notification for a custom AuditSpecification.
`protected boolean`	`objectExists(String tag)` Check whether an object has been registered for the specified tag.
`void`	`postCustomAuditEvent(AttributeValueTable avt)` Post a custom audit event.
`void`	`postCustomAuditEvent(String opTypeKey, String targetTag, String domainTag)` Post a custom audit event.
`void`	`postCustomAuditEvent(String opTypeKey, String targetTag, String domainTag, String auxString, String auxNumber, String auxObjsToken)` Post a custom audit event.
`void`	`postSystemAuditEvent(String opTypeKey, String domainTag)` Post a System audit event.
`void`	`postSystemAuditEvent(String opTypeKey, String domainTag, String auxString, String auxNumber, String auxObjsToken)` Post a System audit event.
`protected void`	`preprocessDocumentSettings(AttributeValueTable avt, DocumentDefinition def)` Preprocess the specified AttributeValueTable for use in creating or updating a Document.
`protected void`	`preprocessPublicObjectSettings(AttributeValueTable avt, PublicObjectDefinition def)` Preprocess the specified AttributeValueTable for use in creating or updating a PublicObject.
`void`	`printStackTrace(Throwable e)` Prints an exception stack trace to the log.
`void`	`processManualTextIndexingRetainedEvents(AttributeValueTable avt)` Processes all of the currently queued ManualTextIndexingRetainedEvents.
`void`	`processRawAuditEvents()` Force processing of raw audit events.
`void`	`purgeGlobalAuditHistory(String domainTag)` Force a purge of the global audit events.
`void`	`reactivateUnknownOperationActionSpecifications()` Re-activate all OperationActionSpecification instances that were previously de-activated via operation `deactivateUnknownOperationActionSpecification`.
`void`	`readDocumentContent(String docTag)` Read a Document content.
`void`	`refreshDependentView(String dvTag)` Refresh the view using the definition contained in a DependentView.
`void`	`registerAllNonCustomAuditTypes()` Registers all non-Custom audit event types.
`void`	`registerAuditEventType(String opTypeKey, String targetCodeVal, String targetClass, String opCodeVal)` Registers an audit event type.
`void`	`registerAuditEventType(String opTypeKey, String targetCodeVal, String targetClass, String opCodeVal, String createOrFreeVal)` Registers an audit event type.
`protected void`	`registerBusinessObject(String tag, Object obj)` Register a BusinessObject by name.
`void`	`registerCustomAuditType(String opCodeKey, String targetClass)` Registers a custom audit event type.
`void`	`registerCustomLockType(AttributeValueTable avt)` Registers a new custom LockEntry type in the locktype lookup table.
`protected void`	`registerDefinition(String tag, LibraryObjectDefinition def)` Register a LibraryObjectDefinition by name.
`void`	`registerLockType(AttributeValueTable avt)` Registers a new LockEntry type in either the core or custom locktype lookup table.
`protected void`	`registerNewSession(String sesstag, LibrarySession sess)` Register a session.
`protected void`	`registerObject(String tag, LibraryObject obj)` Register a LibraryObject by name.
`protected void`	`registerTransaction(String trantag, Transaction tran)` Register a transaction.
`void`	`releaseLock(String poTag, String leTag)` Release a specified lock.
`void`	`releaseManualLock(String poTag)` Release a manual lock.
`void`	`removeAcesForFreedGrantees(String batchValue)` Cleanup ACLs that have ACEs for grantees that have been freed.
`void`	`removeAllAttachments(AttributeValueTable avt)` Removes all attachments from the specified target PublicObject.
`void`	`removeAttachment(AttributeValueTable avt)` Remove an attachment from the specified target PublicObject.
`void`	`removeAttribute(AttributeValueTable avt)` Remove an Attribute for an existing ClassObject.
`void`	`removeClassProperty(AttributeValueTable avt)` Remove a class-level property.
`void`	`removeCustomLockEntry(String poTag, String leTag)` Removes a custom LockEntry from a PublicObject.
`void`	`removeGroupMembers(AttributeValueTable avt)` Removes members from a DirectoryGroup.
`void`	`removeNamedFreezeLock(String docTag, String domainTag, String lockName)` Remove a named freeze (also known as legal hold) lock from a document.
`void`	`removeProperties(AttributeValueTable avt)` Removes a Property or a set of Properties from a PropertyBundle.
`void`	`removeServerFromNodeConfiguration(String ncTag, String sName)` Remove a Server registration from a NodeConfiguration.
`void`	`removeServiceFromNodeConfiguration(String ncTag, String svName)` Remove a Service registration from a NodeConfiguration.
`void`	`removeSession(String sesstag)` Disconnect and de-register a session.
`void`	`removeSessionState(String stateKey)` Remove session state for the specified session state key.
`void`	`removeSingletonLock(AttributeValueTable avt)` Removes a singleton LockEntry from a PublicObject The keys supported by this operation: LOCKTYPEKEY: the lock type key PUBLICOBJECT: the tag that identifies the PublicObject CUSTOM: whether the lock type is custom UNLOCKALLITEMS: whether to recursively unlock all items if the specified PublicObject is a Folder
`void`	`removeTag(String objectTag)` Remove a tag designation.
`void`	`rename(String objectTag, String newName)` Rename a LibraryObject.
`void`	`replaceMediaLookupsByFormat(String currMediaTag, String newMediaTag)` Replaces the Format/Media mappings so that a new Media instance is mapped.
`protected LibrarySession`	`replaceSession(String tag, LibrarySession newSess)` Replace a previously registered session with a different session.
`void`	`resetFolderCountInfo(String folderTag)` Forces an invalidation of count information about a folder.
`void`	`restoreGlobalOperationActionSpecification()` Restores the list of global OperationActionSpecifications from a previously saved copy.
`void`	`runSchemaCreator(String xmlFile)` Run a SchemaCreator for the specified XML file.
`ScriptDriver`	`runScript(String scriptName)` Executes a nested ScriptOperations script file.
`void`	`saveGlobalOperationActionSpecification()` Saves a copy of the list of global OperationActionSpecifications, defined in a domain property.
`protected void`	`saveSearchResultPrimaryObjects(String tag, LibraryObject[] objs)` Saves the search results when selecting the Primary target's objects.
`protected void`	`saveSearchResults(String tag, AttributeValueTable[] rowResults, String priColAlias)` Saves the search results when selecting multiple columns.
`void`	`searchAuditHistory(String specTag, String filterSpec)` Show the Audit events that result from a search against a specified AuditSpecification.
`void`	`searchAuditHistory(String specTag, String filterSpec, String sortClause, String verbose)` Show the Audit events that result from a search against a specified AuditSpecification.
`void`	`searchAuditHistory(String specTag, String targetsToken, String filterSpec, String sortClause, String maxCountValue, String verbose)` Show the Audit events that result from a search against a specified AuditSpecification.
`protected boolean`	`sessionExists(String tag)` Check whether a session has been registered for the specified tag.
`void`	`setAdminMode()` Enable admin mode for the current session.
`void`	`setAdminMode(String boolValue)` Sets Admin mode setting to the value indicated for the current session.
`void`	`setArrayTokenDelimiter(String delim)` Change the the delimiter to use when parsing array tokens.
`protected void`	`setAuditingStartingId(long auditId)` Set the starting point for Audit searches.
`void`	`setAuditSpecificationAuditHandlerSpecificationDefinition(String defTag, String ahsDefTag)` Sets an AuditHandlerSpecification definition on an AuditSpecification definition.
`void`	`setAuditSpecificationAuditTargetSpecificationDefinition(String defTag, String atsDefTag)` Sets an AuditTargetSpecification definition on an AuditSpecification definition.
`void`	`setAuditSpecificationAuditTypeListDefinition(String defTag, String atlDefTag)` Sets an AuditTypeList definition on an AuditSpecification definition.
`void`	`setAuditTargetSpecificationDefinitionTarget(String defTag, String targetTag)` Sets a target on a AuditTargetSpecificationDefinition.
`void`	`setBooleanInstanceProperty(String key, String value)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setClassObjectCreationMode(String execMode)` Sets the mode for scripts that create ClassObjects.
`void`	`setClassPolicyList(AttributeValueTable avt)` Sets a class-level PolicyList.
`void`	`setClassProperty(AttributeValueTable avt)` Sets a class-level Property on the specified ClassObject PropertyBundle.
`void`	`setCreateCategoriesServerSideOption(String defTag, String attrValue)` Sets the create categories server side option on the public object definition.
`protected void`	`setCurrentSession(LibrarySession session)` Make the specified session the default.
`void`	`setCurrentSession(String sesstag)` Make a different session the current session.
`void`	`setDateFormat(String dateFormat)` Change the date formatter used by the current session's Localizer.
`void`	`setDefaultAuditEventSortClause(String sort)` Set the default manner in which audit event searches are sorted.
`void`	`setDefaultMedia(String mediaTag)` Sets the default Media.
`void`	`setDefaultScriptOperationsClass(String className)` Sets the class name of the instance to use as the default script operations class.
`void`	`setDefaultStorageGroup(String sgTag)` Sets the default StorageGroup.
`void`	`setDefinitionAttribute(AttributeValueTable avt)` Add an attribute setting to a definition.
`protected void`	`setDefinitionAttribute(LibraryObjectDefinition def, String attrName, AttributeValue value)` Sets an attribute on the specified definition.
`void`	`setDefinitionBooleanAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionClassObjectAttribute(String defTag, String attrName, String classTag)` Deprecated. 9.0.4.6: use `setDefinitionAttribute` and the LIBRARYOBJECTVALUE option
`void`	`setDefinitionDateAttribute(String defTag, String attrName, String dateString)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionDirectoryObjectArrayAttribute(String defTag, String attrName, String doTagNames)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionDirectoryObjectAttribute(String defTag, String attrName, String objTag)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionDoubleAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionIntegerAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionLongAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionNullStringAttribute(String defTag, String attrName)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`, value = ""
`void`	`setDefinitionObjectAttribute(String defTag, String attrName, String objTag)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionSchemaObjectArrayAttribute(String defTag, String attrName, String koTagNames)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionSchemaObjectAttribute(String defTag, String attrName, String objTag)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionStringArrayAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionStringAttribute(String defTag, String attrName, String attrValue)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDefinitionSystemObjectAttribute(String defTag, String attrName, String objTag)` Deprecated. 9.0.4.6: use `setDefinitionAttribute`
`void`	`setDocumentDefinitionContentObjectDefinition(String defTag, String coDefTag)` Deprecated. 9.0.4.6: use `addToDocumentDefinition`
`void`	`setGlobalAuditTypeList(String atlTag)` Change the AuditTypeList used for global audit history.
`void`	`setGlobalOperationActionSpecifications(String oasArrayToken)` Sets the list of global OperationActionSpecifications defined as a domain property.
`void`	`setInstallationMode()` Enable installation mode for the current session.
`void`	`setInstallationMode(String boolValue)` Sets installation mode setting to the value indicated for the current session.
`void`	`setInstanceProperty(AttributeValueTable avt)` Sets an "instance" property, i.e. a property in the Domain PropertyBundle.
`void`	`setIntegerInstanceProperty(String key, String value)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setLifecyclePolicyDefinitionDeleteEntriesOption(String defTag, String boolVal)` Sets the "DeleteAllLifecyclePolicyEntries" option on a LifecyclePolicyDefinition.
`void`	`setLocale(String locString)` Change the Locale used by the current session's Localizer.
`void`	`setLongInstanceProperty(String key, String value)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setLongSessionState(String stateKey, String value)` Set Long session state for the specified session state key.
`void`	`setMainSessionAsCurrentSession()` Sets the main session in the script driver as the current session.
`void`	`setMediaLookupByFormat(String formatName, String mediaTag)` Adds a mapping to the MediaLookUpByFormat property bundle, which holds the mappings of Format to Media.
`void`	`setNumberFormat(AttributeValueTable avt)` Change the number formatter used by the current session's Localizer.
`void`	`setObjectProperty(AttributeValueTable avt)` Sets a Property on a specified LibraryObject.
`void`	`setPreventSessionTimeouts()` Prevent session timeouts from occuring for the current session.
`void`	`setPreventSessionTimeouts(String boolValue)` Sets indication as to whether session timeouts are prevented for the current session.
`void`	`setProperty(AttributeValueTable avt)` Sets a Property on an identified PropertyBundle.
`void`	`setPublicObjectInstanceProperty(String key, String tag)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setRepositoryParameter(AttributeValueTable avt)` Sets a repository parameter.
`void`	`setStringInstanceProperty(String key, String value)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setStringSessionState(String stateKey, String value)` Set String session state for the specified session state key.
`void`	`setSubstitutionPrefix(String prefix)` Change the prefix indicating a substitution reference.
`void`	`setSystemAdminMode()` Enable system admin mode for the current session.
`void`	`setSystemAdminMode(String boolValue)` Sets System Admin mode setting to the value indicated for the current session.
`void`	`setSystemObjectInstanceProperty(String key, String tag)` Deprecated. 9.0.4.6: use `setInstanceProperty`
`void`	`setTimeoutPeriodOption(String defTag, String attrValue)` Sets the "timeout period" option onto a ApplicationTokenDefinition.
`void`	`setTimeZone(String tzString)` Change the time zone used by the current session's Localizer.
`protected void`	`setUserCreateOptions(AttributeValueTable avt, Hashtable ht)` Sets options for user creation on the specified options Hashtable.
`void`	`setUserDefaultAcl(String aclName, String userName)` Sets the users default ACL for new created POs.
`protected void`	`setUserDeleteOptions(AttributeValueTable avt, Hashtable ht)` Sets options for user delete on the specified options Hashtable.
`void`	`showAcl(String aclTag)` Show details about an ACL.
`void`	`showAggregateAuditEventColumns(String specTag, String aggFunction, String columnNamesTag, String innerColNamesTag, String filterSpec, String sortClause, String verbose)` Shows the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.
`void`	`showAllAutoFolderingActionSpecifications()` Shows all of the AutoFolderingActionSpecifications.
`void`	`showAllClassAcls()` Show details about all System ACLs.
`void`	`showAllClassDomains()` Shows all of the ClassDomains.
`void`	`showAllClassObjects(AttributeValueTable avt)` Shows all of the ClassObjects.
`void`	`showAllCustomAuditSpecifications()` Shows all of the custom audit specifications.
`void`	`showAllCustomMediaDriverSpecifications()` Shows all of the CustomMediaDriverSpecification instances.
`void`	`showAllDependentViews()` Shows all of the DependentViews.
`void`	`showAllExtendedPermissions()` Shows all of the ExtendedPermissions.
`void`	`showAllExternalRetentionPolicies()` Shows all of the ExternalRetentionPolicy instances.
`void`	`showAllFormats()` Shows all of the Formats.
`void`	`showAllLifecycleDateRuleSpecifications()` Shows all of the LifecycleDateRuleSpecifications.
`void`	`showAllLifecyclePolicies()` Shows all of the LifecyclePolicy instances.
`void`	`showAllLifecyclePolicyActionSpecifications()` Shows all of the LifecyclePolicyActionSpecifications.
`void`	`showAllMedias()` Shows all of the Media instances.
`void`	`showAllNodeConfigurations()` Shows all of the NodeConfiguration instances.
`void`	`showAllNodeConfigurations(String verboseVal)` Shows all of the NodeConfiguration instances.
`void`	`showAllOperationActionSpecifications()` Shows all of the OperationActionSpecifications.
`void`	`showAllPermissionBundles()` Shows all of the PermissionBundles.
`void`	`showAllPolicies()` Shows all of the Policies.
`void`	`showAllPolicyLists()` Shows all of the PolicyLists.
`void`	`showAllRepositoryParameters()` Shows all repository parameters.
`void`	`showAllRetentionPolicies()` Shows all of the RetentionPolicy instances.
`void`	`showAllServerConfigurations()` Shows all of the ServerConfiguration instances.
`void`	`showAllServerConfigurations(String verboseVal)` Shows all of the ServerConfiguration instances.
`void`	`showAllServerSpecifications()` Shows all of the ServerSpecifications.
`void`	`showAllServiceConfigurations()` Shows all of the ServiceConfiguration instances.
`void`	`showAllServiceConfigurations(String verboseVal)` Shows all of the ServiceConfiguration instances.
`void`	`showAllStorageGroups()` Shows all of the StorageGroups.
`void`	`showAllSystemAcls()` Show details about all System ACLs.
`void`	`showAllValueDefaults()` Shows all of the ValueDefaults.
`void`	`showAllValueDomains()` Shows all of the ValueDomains.
`void`	`showApplicationToken(String tkTag)` Show details about a ApplicationToken.
`void`	`showApplicationTokens()` Show details about all ApplicationTokens in an Instance.
`void`	`showAttachments(AttributeValueTable avt)` Show attachments for the specified target PublicObject.
`void`	`showAttribute(String tag)` Show details about an Attribute.
`void`	`showAttribute(String objectTag, String attrName)` Show the attribute value of an object.
`void`	`showAuditCertificates(String objTags, String verbose)` Shows audit certificates for the array of object tags specified.
`void`	`showAuditEventOperationTypes(String opTypeKeys)` Converts a set of audit operation code keys to their numeric equivalents, and shows them.
`void`	`showAuditSpecification(String objectTag)` Shows the audit specification corresponding to the supplied tag.
`void`	`showAuditTypeList(String objectTag)` Shows the audit type list corresponding to the supplied tag.
`void`	`showAuditTypesForClass(String className)` Shows the set of audit operation types that are applicable to the class specified.
`void`	`showAuditTypesForCreateOperations()` Shows the set of audit operation types that represent "created" operations.
`void`	`showAuditTypesForFreeOperations()` Shows the set of audit operation types that represent "free" operations.
`void`	`showAuditTypesUnderClass(String className)` Shows the set of audit operation types that are applicable to the specified class, or any of the classes considered to descend from the specified class.
`void`	`showAutoFolderingActionSpecification(String specTag)` Show details about a AutoFolderingActionSpecification.
`void`	`showCapabilities(String objTag)` Show Capabilities for a PublicObject.
`void`	`showClassDomain(AttributeValueTable avt)` Shows a ClassDomain.
`void`	`showClassDomain(String name)` Show details about a ClassDomain.
`void`	`showClassObject(AttributeValueTable avt)` Show a ClassObject.
`protected void`	`showClassObjectAndSubNames(ClassObject co, boolean inclInstalled, boolean inclCustom, String indent)` Shows the name of the specified class and each of its subclasses, recursively.
`protected void`	`showClassObjectAndSubs(ClassObject co, boolean createSyntax, boolean inclInstalled, boolean inclCustom, boolean verbose, boolean showDates)` Shows the specified class and each of its subclasses, recursively
`void`	`showCompositeGroup(String groupTag)` Show details about a CompositeGroup.
`protected void`	`showCreateClassObjectScript(ClassObject co, boolean verbose, boolean showDates)` Shows the specified class using "create script" syntax.
`void`	`showCurrentUser()` Shows information about the currently connected user.
`void`	`showCustomAuditHistory(String specTag, String verbose)` Show the Audit events for a custom AuditSpecification.
`void`	`showCustomAuditHistory(String specTag, String verbose, String sortClause)` Show the Audit events for a custom AuditSpecification.
`void`	`showCustomAuditTypes()` Shows the set of custom audit operation types.
`void`	`showCustomMediaDriverSpecification(String cmdsTag)` Shows details about a CustomMediaDriverSpecification.
`void`	`showDefaultMedia()` Shows the default Media.
`void`	`showDefaultStorageGroup()` Shows the default StorageGroup.
`protected void`	`showDefineAttributeScript(Attribute attr, String className, boolean verbose, boolean showDates)` Shows the specified Attribute using "create script" syntax.
`void`	`showDefinition(String defTag)` Show details about a definition.
`void`	`showDefinitionObject(String defobjTag)` Show details about a DefinitionObject.
`void`	`showDependentView(String dvTag)` Show details about a DependentView.
`void`	`showDocument(String docTag)` Show details about a document.
`void`	`showDocumentCharacterSet(String docTag)` Deprecated. 9.0.4.6: use `showDocumentContentInfo`
`void`	`showDocumentContentInfo(String docTag)` Show details about a document's content.
`protected void`	`showDocumentContents(Document doc, String prefix)` Show a Document's content, using its Reader.
`protected void`	`showDocumentContents(Document doc, String prefix, boolean replaceNums)` Show a Document's content, using its Reader, and optionally replacing all numbers with an X (for test output).
`void`	`showDocumentContents(String docTag)` Show a document's content.
`void`	`showDocumentLanguage(String docTag)` Deprecated. 9.0.4.6: use `showDocumentContentInfo`
`void`	`showDocumentsWithLifecyclePolicy(String lpTag, String batchValue)` Show documents that are referencing the specified LifecyclePolicy.
`void`	`showExpandedAuditTypeList(String objectTag, String className)` Shows the expanded audit type list corresponding to the supplied tag, and the specified class.
`void`	`showExtendedPermission(String name)` Show details about a ExtendedPermission.
`void`	`showFolder(AttributeValueTable avt)` Show details about a folder.
`void`	`showFolder(String folderTag)` Show details about a folder.
`void`	`showFolderCountInfo(String folderTag)` Show count information about a folder.
`void`	`showFormat(String formatName)` Show details about a Format.
`void`	`showGlobalAuditHistory(String verbose)` Show the Global Audit History.
`void`	`showGlobalAuditHistory(String verbose, String sortClause)` Show the Global Audit History.
`void`	`showGlobalAuditSpecification()` Shows the Global audit spec.
`void`	`showGlobalAuditTypeList()` Show the AuditTypeList used for global audit history.
`void`	`showGlobalOperationActionSpecifications()` Shows the list of global OperationActionSpecifications defined as a domain property.
`void`	`showGroup(String groupTag)` Show details about a group.
`void`	`showInstanceProperty(String key)` Show an instance property.
`void`	`showInstancePropertyBundle()` Show the instance PropertyBundle.
`void`	`showLibraryObject(AttributeValueTable avt)` Show details about a LibraryObject.
`protected void`	`showLibraryObject(Logger logger, LibraryObject obj, boolean showDates, String prefix)` Show details about a LibraryObject.
`void`	`showLifecycleDateRuleSpecification(String specTag)` Show details about a LifecycleDateRuleSpecification.
`void`	`showLifecyclePolicy(String lpTag)` Show details about a LifecyclePolicy.
`void`	`showLifecyclePolicyActionSpecification(String specTag)` Show details about a LifecyclePolicyActionSpecification.
`void`	`showLifecyclePolicyEntry(String lpeTag)` Show details about a LifecyclePolicyEntry.
`void`	`showLink(String linkTag)` Show details about a link.
`void`	`showLocalizer()` Change the date formatter used by the current session's Localizer.
`void`	`showLockEntry(String leTag)` Show a lock entry.
`void`	`showLockEntryInfo(String poTag)` Show the lock entry info for a specified PublicObject
`void`	`showLockTypeLookupTables()` Shows the lock type lookup tables in the instance-wide Domain PropertyBundle.
`void`	`showMedia(String mediaTag)` Shows details about a Media.
`void`	`showMediaLookupByFormatMappings()` Shows the MediaLookUpByFormat property bundle, which holds the mappings of Format to Media.
`void`	`showMessageEntry(AttributeValueTable avt)` Show MessageEntry information.
`void`	`showMessageList(AttributeValueTable avt)` Show MessageList information.
`void`	`showNamedPropertyBundle(String name)` Show details about a Named PropertyBundle.
`void`	`showNodeConfiguration(String ncTag)` Show details about a NodeConfiguration.
`void`	`showNodeConfiguration(String ncTag, String verboseVal)` Show details about a NodeConfiguration.
`void`	`showObject(String objTag)` Show details about a LibraryObject.
`void`	`showObjectAuditHistory(String objTag, String verbose)` Show the Object Audit History for an object.
`void`	`showObjectAuditHistory(String objTag, String verbose, String sortClause)` Show the Object Audit History for an object.
`void`	`showObjectAuditSpecification()` Shows the Global audit spec.
`void`	`showOperationActionSpecification(String tagOrName)` Show details about a OperationActionSpecification.
`void`	`showParsedArrayToken(AttributeValueTable avt)` Show a parsed array token for the string specified.
`void`	`showParsedOperationString(AttributeValueTable avt)` Show a parsed operation for the string specified.
`void`	`showPermissionBundle(String name)` Show details about a PermissionBundle.
`void`	`showPolicy(String name)` Show details about a Policy.
`void`	`showPolicyList(String name)` Show details about a PolicyList.
`void`	`showPreparedSelector(PreparedSelector sel)` Show details about a PreparedSelector.
`void`	`showPreparedSelector(PreparedSelector sel, boolean showBindVals)` Show details about a PreparedSelector.
`void`	`showProperty(String pbTag, String key)` Shows a property of a PropertyBundle.
`void`	`showPropertyBundle(String pbTag)` Shows the properties of a PropertyBundle.
`void`	`showRepositoryParameter(AttributeValueTable avt)` Shows a repository parameter.
`void`	`showRetentionPolicy(String rpTag)` Show details about a RetentionPolicy.
`void`	`showRuntimeStatistics()` Show runtime statistics for the current JVM.
`void`	`showSavedSearchResultPrimaryObjects(AttributeValueTable avt)` Show the Primary objects selected in the search results that were saved as part of executing a query previously.
`void`	`showSavedSearchResults(AttributeValueTable avt)` Show the search results that were saved as part of executing a query previously.
`void`	`showServerConfiguration(String scTag)` Show details about a ServerConfiguration.
`void`	`showServerConfiguration(String scTag, String verboseVal)` Show details about a ServerConfiguration.
`void`	`showServerSpecification(String specTag)` Show details about a ServerSpecification.
`void`	`showServiceConfiguration(String scTag)` Show details about a ServiceConfiguration.
`void`	`showServiceConfiguration(String scTag, String verboseVal)` Show details about a ServiceConfiguration.
`void`	`showServiceStatistics()` Show the current service statistics.
`void`	`showSessionCacheStatistics()` Show session cache statistics for the current session.
`void`	`showSessionState(String stateKey)` Show the session state value in the current session for the specified session state key.
`void`	`showSimplePropertyTable(AttributeValueTable avt)` Shows a SimplePropertyTable.
`void`	`showSimplePropertyTableList(AttributeValueTable avt)` Shows a SimplePropertyTableList.
`void`	`showStorageGroup(String sgTag)` Shows details about a StorageGroup.
`void`	`showUser(String userName)` Shows information about a user.
`void`	`showValueDefault(AttributeValueTable avt)` Shows a ValueDefault.
`void`	`showValueDefault(String name)` Show details about a ValueDefault.
`void`	`showValueDomain(AttributeValueTable avt)` Shows a ValueDomain.
`void`	`showValueDomain(String name)` Show details about a ValueDomain.
`void`	`sleep(String sleepLength)` Sleep for the specified time period.
`void`	`syncContentIndex()` Trigger a sync of the content index.
`void`	`syncIndex(AttributeValueTable avt)` Sync the specified Oracle Text index by name.
`void`	`testJsonString(AttributeValueTable avt)` Perform operations on a JSON string.
`protected DirectoryObject[]`	`tokenToDirectoryObjectArray(LibrarySession sess, String doTagNames)` Convert a token representing an array of DirectoryObjects into the array of DirectoryObjects.
`protected DirectoryUser[]`	`tokenToDirectoryUserArray(LibrarySession sess, String userTagNames)` Convert a token representing an array of DirectoryUsers into the array of DirectoryUsers.
`protected Document[]`	`tokenToDocumentArray(LibrarySession sess, String token)` Get an array of Documents from the specified array token containing Document tags.
`protected boolean`	`transactionExists(String tag)` Check whether a Transaction has been registered for the specified tag.
`void`	`unregisterAuditEventType(String opTypeKey)` Unregisters an audit event type.
`void`	`unregisterCustomAuditType(String opCodeKey, String targetClass)` Unregisters a custom audit event type.
`void`	`update(String objectTag, String defTag)` Update a LibraryObject, using `update`.
`void`	`updateAccessControlList(AttributeValueTable avt)` Updates an AccessControlList.
`void`	`updateClassDomain(AttributeValueTable avt)` Updates a ClassDomain.
`void`	`updateDefinitionObject(String defobjTag, String defTag)` Update a DefinitionObject.
`void`	`updateLibraryObject(AttributeValueTable avt)` Updates a LibraryObject.
`protected void`	`updateLibraryObject(AttributeValueTable avt, LibraryObject existingObj)` Updates the specified LibraryObject with the updates in the specified table.
`protected void`	`updateLibraryObject(AttributeValueTable avt, LibraryObjectDefinition def, LibraryObject existingObj)` Updates the specified LibraryObject with the updates in the specified table.
`void`	`updateNodeConfiguration(AttributeValueTable avt)` Update a NodeConfiguration.
`void`	`updateNodeConfiguration(String ncTag, String defTag)` Update a NodeConfiguration.
`void`	`updateServerConfiguration(AttributeValueTable avt)` Update a ServerConfiguration.
`void`	`updateServerConfiguration(String scTag, String defTag)` Update a ServerConfiguration.
`void`	`updateServiceConfiguration(AttributeValueTable avt)` Update a ServiceConfiguration.
`void`	`updateServiceConfiguration(String svcTag, String defTag)` Update a ServiceConfiguration.
`void`	`updateUserPassword(AttributeValueTable avt)` Updates the password for a User.
`void`	`updateValueDefault(AttributeValueTable avt)` Updates a ValueDefault.
`void`	`updateValueDomain(AttributeValueTable avt)` Updates a ValueDomain.
`protected void`	`verifyBusinessObjectTagNotExists(String defTag)` Verify that the specified BusinessObject tag does not already exist.
`protected void`	`verifyDefinitionTagNotExists(String defTag)` Verify that the specified definition tag does not already exist.
`protected void`	`verifyDefinitionWriteable(LibrarySession sess, String tag)` Verify that a LibraryObjectDefinition identified by the specified tag is writeable.
`protected void`	`verifyObjectTagNotExists(String objTag)` Verify that the specified object tag does not already exist.
`void`	`writeConsoleOutputString()` Force newline write to the console.
`void`	`writeConsoleOutputString(String prompt)` Write string to the console.
`void`	`writeDocumentContentToFile(String docTag, String fileName)` Write a Document's content to a local file
`protected String`	`zeroPad(String str, int padLength)` Pre-pad a string with 0's.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INDENT
```
public static final String INDENT
```
    Amount to indent when displaying layered information
    
    See Also:
    
    Constant Field Values
    
    (Published)
- Constructor Detail
  - ScriptOperations
```
public ScriptOperations(ScriptDriver driver)
```
    Construct a ScriptOperations
    
    Parameters:
    
    driver - the main script driver instance
    
    (Published)
- Method Detail
  - getDriver
```
public ScriptDriver getDriver()
```
    Return the script driver used to construct this instance.
    
    Returns:
    
    the driver
    
    (Published)
  - getLogWriter
```
public PrintWriter getLogWriter()
```
    Return the log writer in use.
    
    Returns:
    
    the writer used for logging the output
    
    (Published)
  - getAuditDriverHelper
```
public AuditDriverHelper getAuditDriverHelper()
```
    Return the AuditDriverHelper in use.
    
    Returns:
    
    the AuditDriverHelper used for auditing management
    
    (Published)
  - getShowDates
```
public boolean getShowDates()
```
    Return indication as to whether dates should be shown in the output.
    
    Returns:
    
    true if date values should be shown in the output; false otherwise
    
    (Published)
  - getStripNumbersFromAuditEventProperties
```
public boolean getStripNumbersFromAuditEventProperties()
```
    Return indication as to whether numbers should be replaced in audit event properties in ShowUtils.showAuditEvents.
    
    Returns:
    
    true if numbers should be replaced in the output; false otherwise
    
    (Published)
  - constructPreparedSelectorGenerator
```
protected PreparedSelectorGenerator constructPreparedSelectorGenerator()
                                                                throws IfsException
```
    Return a newly constructed instance of a PreparedSelectorGenerator.
    
    Returns:
    
    the newly constructed PreparedSelectorGenerator
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - constructPreparedSelectorGenerator
```
protected PreparedSelectorGenerator constructPreparedSelectorGenerator(String psGenClassName)
                                                                throws IfsException
```
    Return a newly constructed instance of a PreparedSelectorGenerator, of the specified class.
    
    Parameters:
    
    psGenClassName - the fully qualified class name
    
    Returns:
    
    the newly constructed PreparedSelectorGenerator
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isDomainScopeImpliedForSearch
```
protected boolean isDomainScopeImpliedForSearch()
```
    Returns indication as to whether a Domain ID scoping is implied for Audit searches.
    
    Returns:
    
    true if Domain scoping is implied; false otherwise
    
    (Published)
  - showLibraryObject
```
protected void showLibraryObject(Logger logger,
                                 LibraryObject obj,
                                 boolean showDates,
                                 String prefix)
                          throws IfsException
```
    Show details about a LibraryObject.
    Delegates to various more specific methods based on the type of object.
    
    Parameters:
    
    logger - the log context
    
    obj - the LibraryObject to show
    
    showDates - whether to show date info
    
    prefix - the indentation prefix
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDefaultScriptOperationsClass
```
public void setDefaultScriptOperationsClass(String className)
```
    Sets the class name of the instance to use as the default script operations class.
    
    Parameters:
    
    className - the name of the default ops class to use
    
    (Published)
  - runScript
```
public ScriptDriver runScript(String scriptName)
                       throws IfsException
```
    Executes a nested ScriptOperations script file.
    
    Parameters:
    
    scriptName - the path to the script file, relative to the IncludePaths specified
    
    Returns:
    
    the ScriptDriver instance used to execution the nested script
    
    Throws:
    
    IfsException - if the script file cannot be found
  - createSession
```
public void createSession(String sesstag,
                          String username)
                   throws IfsException
```
    Register a session.
    This registers a two-way lookup, enabling finding the session by the specified session tag, and the ability to determine the session tag from the LibrarySession.
    
    Parameters:
    
    sesstag - the session tag
    
    username - the user name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createSession
```
public void createSession(String sesstag,
                          String username,
                          String password)
                   throws IfsException
```
    Register a session.
    This registers a two-way lookup, enabling finding the session by the specified session tag, and the ability to determine the session tag from the LibrarySession.
    
    Parameters:
    
    sesstag - the session tag
    
    username - the user name
    
    password - the user's password
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setCurrentSession
```
public void setCurrentSession(String sesstag)
                       throws IfsException
```
    Make a different session the current session.
    
    Parameters:
    
    sesstag - the session tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeSession
```
public void removeSession(String sesstag)
                   throws IfsException
```
    Disconnect and de-register a session.
    This disconnects the session (identied by tag) and then removes it from the session lookup tables.
    
    Parameters:
    
    sesstag - session tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - cloneCurrentSession
```
public void cloneCurrentSession(AttributeValueTable avt)
                         throws IfsException
```
    Clone the current session.
    The keys supported by this operation:
    - CLONEDSESSIONTAG: the tag that will identify the newly cloned session
    - USER: the user for which the newly cloned session is the creator (future)
    - BECOMECURRENTSESSION: whether the newly cloned session should become the current session
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDateFormat
```
public void setDateFormat(String dateFormat)
                   throws IfsException
```
    Change the date formatter used by the current session's Localizer.
    
    Parameters:
    
    dateFormat - String to pass to a SimpleDateFormat constructor
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setNumberFormat
```
public void setNumberFormat(AttributeValueTable avt)
                     throws IfsException
```
    Change the number formatter used by the current session's Localizer.
    
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setArrayTokenDelimiter
```
public void setArrayTokenDelimiter(String delim)
                            throws IfsException
```
    Change the the delimiter to use when parsing array tokens.
    
    Parameters:
    
    delim - the delimiter to use when parsing array tokens
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setSubstitutionPrefix
```
public void setSubstitutionPrefix(String prefix)
```
    Change the prefix indicating a substitution reference.
    
    (Published)
  - showParsedArrayToken
```
public void showParsedArrayToken(AttributeValueTable avt)
                          throws IfsException
```
    Show a parsed array token for the string specified.
    The keys supported by this operation:
    - TOKEN: the token to parse
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - showParsedOperationString
```
public void showParsedOperationString(AttributeValueTable avt)
                               throws IfsException
```
    Show a parsed operation for the string specified.
    The keys supported by this operation:
    - OPERATION: the operation to parse
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - setTimeZone
```
public void setTimeZone(String tzString)
                 throws IfsException
```
    Change the time zone used by the current session's Localizer.
    
    Parameters:
    
    tzString - Time zone ID (e.g. "America/Los_Angeles")
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setLocale
```
public void setLocale(String locString)
               throws IfsException
```
    Change the Locale used by the current session's Localizer.
    
    Parameters:
    
    locString - the string representation of the Locale (e.g. "en_US")
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showLocalizer
```
public void showLocalizer()
                   throws IfsException
```
    Change the date formatter used by the current session's Localizer.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createGuestSession
```
public void createGuestSession(String sesstag)
                        throws IfsException
```
    Create a new session for the "guest" user.
    The current session remains intact. If able to create a guest session, that session becomes the current session.
    
    Parameters:
    
    sesstag - session tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createUserSession
```
public void createUserSession(String sesstag,
                              String userName)
                       throws IfsException
```
    Create a new session for a user, from the current adin-mode session.
    
    Parameters:
    
    sesstag - session tag for the newly created session
    
    userName - the user name to use for the new session
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showUser
```
public void showUser(String userName)
              throws IfsException
```
    Shows information about a user.
    
    Parameters:
    
    userName - user name or tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showCurrentUser
```
public void showCurrentUser()
                     throws IfsException
```
    Shows information about the currently connected user.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - beginTransaction
```
public void beginTransaction(String trantag)
                      throws IfsException
```
    Begin an outer transaction.
    This transaction needs to be explicitly completed or aborted.
    
    Parameters:
    
    trantag - the transaction tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - abortTransaction
```
public void abortTransaction(String trantag)
                      throws IfsException
```
    Abort an outer transaction.
    
    Parameters:
    
    trantag - the transaction tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - completeTransaction
```
public void completeTransaction(String trantag)
                         throws IfsException
```
    Complete an outer transaction.
    
    Parameters:
    
    trantag - the transaction tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - markCurrentAuditingId
```
public void markCurrentAuditingId()
                           throws IfsException
```
    Mark the starting point for subsequent audit event searches.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDefaultAuditEventSortClause
```
public void setDefaultAuditEventSortClause(String sort)
                                    throws IfsException
```
    Set the default manner in which audit event searches are sorted.
    
    Parameters:
    
    sort - sort specification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - processRawAuditEvents
```
public void processRawAuditEvents()
                           throws IfsException
```
    Force processing of raw audit events.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - handleEventPostedForCustomAuditHistory
```
public void handleEventPostedForCustomAuditHistory(String specTag)
                                            throws IfsException
```
    Initialize and post a "event posted" notification for a custom AuditSpecification.
    This mimics what the EventHandlerAgent does when a new event is posted for a custom AuditSpecification. Only works for INTERNAL handlers.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - handleTimerExpiredForCustomAuditHistory
```
public void handleTimerExpiredForCustomAuditHistory(String specTag)
                                             throws IfsException
```
    Initialize and post a "timer expired" notification for a custom AuditSpecification.
    This mimics what the EventHandlerAgent does when a timer expired notification is posted for a custom AuditSpecification. Only works for INTERNAL handlers.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - notifyCustomAuditHistoryHandler
```
public void notifyCustomAuditHistoryHandler(String specTag,
                                            String notifyType)
                                     throws IfsException
```
    Initialize and post a notification for a custom AuditSpecification.
    Notification can be for either a "event posted", "timer expired", or both. This mimics what the EventHandlerAgent does for processing a custom AuditSpecification. Only works for INTERNAL handlers.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    notifyType - type of notification; must be "EVENT_POSTED", "TIMER_EXPIRED", or "BOTH"
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - postCustomAuditEvent
```
public void postCustomAuditEvent(String opTypeKey,
                                 String targetTag,
                                 String domainTag)
                          throws IfsException
```
    Post a custom audit event.
    
    Parameters:
    
    opTypeKey - operation type key
    
    targetTag - target object
    
    domainTag - domain context
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - postCustomAuditEvent
```
public void postCustomAuditEvent(String opTypeKey,
                                 String targetTag,
                                 String domainTag,
                                 String auxString,
                                 String auxNumber,
                                 String auxObjsToken)
                          throws IfsException
```
    Post a custom audit event.
    
    Parameters:
    
    opTypeKey - operation type key
    
    targetTag - target object
    
    domainTag - domain context
    
    auxString - auxiliary string
    
    auxNumber - auxiliary number
    
    auxObjsToken - auxiliary objects token
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - postCustomAuditEvent
```
public void postCustomAuditEvent(AttributeValueTable avt)
                          throws IfsException
```
    Post a custom audit event.
    The keys supported by this operation:
    - OPERATIONTYPEKEY: the Operation type key
    - TARGETTAG: the tag that identifies the object receiving the event
    - DOMAINTAG: the tag that identifies the Domain
    - AUXILIARYSTRING: the auxiliary String value to post with the event
    - AUXILIARYNUMBER: the auxiliary Number value to post with the event
    - AUXILIARYOBJECTS: the auxiliary object values to post with the event
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - postSystemAuditEvent
```
public void postSystemAuditEvent(String opTypeKey,
                                 String domainTag)
                          throws IfsException
```
    Post a System audit event.
    
    Parameters:
    
    opTypeKey - operation type key
    
    domainTag - domain context
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - postSystemAuditEvent
```
public void postSystemAuditEvent(String opTypeKey,
                                 String domainTag,
                                 String auxString,
                                 String auxNumber,
                                 String auxObjsToken)
                          throws IfsException
```
    Post a System audit event.
    
    Parameters:
    
    opTypeKey - operation type key
    
    domainTag - domain context
    
    auxString - auxiliary string
    
    auxNumber - auxiliary number
    
    auxObjsToken - auxiliary objects token
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - constructAuditEvent
```
protected AuditEvent constructAuditEvent(LibraryObject target,
                                         String opTypeKey,
                                         String domainTag,
                                         String auxString,
                                         String auxNumber,
                                         String auxObjsToken)
                                  throws IfsException
```
    Construct an audit event, to be posted as either a Custom or System AuditEvent.
    
    Parameters:
    
    target - target object
    
    opTypeKey - operation type key
    
    domainTag - domain context
    
    auxString - auxiliary string
    
    auxNumber - auxiliary number
    
    auxObjsToken - auxiliary objects token
    
    Returns:
    
    the AuditEvent, ready for posting
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addAuditEventProperty
```
public void addAuditEventProperty(String propName,
                                  String propValue)
                           throws IfsException
```
    Add an audit event property to an internal list, to be posted as part of the next postCustomAuditEvent operation.
    
    Parameters:
    
    propName - property key
    
    propValue - property value
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGlobalAuditHistory
```
public void showGlobalAuditHistory(String verbose)
                            throws IfsException
```
    Show the Global Audit History.
    This shows all audit events in the global audit history that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGlobalAuditHistory
```
public void showGlobalAuditHistory(String verbose,
                                   String sortClause)
                            throws IfsException
```
    Show the Global Audit History.
    This shows all audit events in the global audit history that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    verbose - should output be verbose?
    
    sortClause - how the events should be sorted
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - purgeGlobalAuditHistory
```
public void purgeGlobalAuditHistory(String domainTag)
                             throws IfsException
```
    Force a purge of the global audit events.
    
    Parameters:
    
    domainTag - the auditing domain context (typically root folder)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setGlobalAuditTypeList
```
public void setGlobalAuditTypeList(String atlTag)
                            throws IfsException
```
    Change the AuditTypeList used for global audit history.
    
    Parameters:
    
    atlTag - the AuditTypeList tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyGlobalAuditTypeList
```
public void identifyGlobalAuditTypeList(String atlTag)
                                 throws IfsException
```
    Identifies the AuditTypeList used for global audit history.
    
    Parameters:
    
    atlTag - the AuditTypeList tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGlobalAuditTypeList
```
public void showGlobalAuditTypeList()
                             throws IfsException
```
    Show the AuditTypeList used for global audit history.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showObjectAuditHistory
```
public void showObjectAuditHistory(String objTag,
                                   String verbose)
                            throws IfsException
```
    Show the Object Audit History for an object.
    This shows all audit events in the object audit history for the specified object.
    
    Parameters:
    
    objTag - the object tag
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showObjectAuditHistory
```
public void showObjectAuditHistory(String objTag,
                                   String verbose,
                                   String sortClause)
                            throws IfsException
```
    Show the Object Audit History for an object.
    This shows all audit events in the object audit history for the specified object.
    
    Parameters:
    
    objTag - the object tag
    
    verbose - should output be verbose?
    
    sortClause - how the events should be sorted
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showCustomAuditHistory
```
public void showCustomAuditHistory(String specTag,
                                   String verbose)
                            throws IfsException
```
    Show the Audit events for a custom AuditSpecification.
    This shows all audit events in the AuditSpecification specified that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showCustomAuditHistory
```
public void showCustomAuditHistory(String specTag,
                                   String verbose,
                                   String sortClause)
                            throws IfsException
```
    Show the Audit events for a custom AuditSpecification.
    This shows all audit events in the AuditSpecification specified that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    verbose - should output be verbose?
    
    sortClause - how the events should be sorted
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - searchAuditHistory
```
public void searchAuditHistory(String specTag,
                               String filterSpec)
                        throws IfsException
```
    Show the Audit events that result from a search against a specified AuditSpecification.
    Automatically includes a search condition to only include audit events that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    filterSpec - search condition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - searchAuditHistory
```
public void searchAuditHistory(String specTag,
                               String filterSpec,
                               String sortClause,
                               String verbose)
                        throws IfsException
```
    Show the Audit events that result from a search against a specified AuditSpecification.
    Automatically includes a search condition to only include audit events that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    filterSpec - search condition
    
    sortClause - how the events should be sorted
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - searchAuditHistory
```
public void searchAuditHistory(String specTag,
                               String targetsToken,
                               String filterSpec,
                               String sortClause,
                               String maxCountValue,
                               String verbose)
                        throws IfsException
```
    Show the Audit events that result from a search against a specified AuditSpecification.
    Automatically includes a search condition to only include audit events that were created after the ID established via a call to markCurrentAuditingId.
    Uses AuditSearchGenerator to check authorization if targets are specified.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    targetsToken - the event targets if any
    
    filterSpec - search condition
    
    sortClause - how the events should be sorted
    
    maxCountValue - the maximum number of items to show
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAggregateAuditEventColumns
```
public void showAggregateAuditEventColumns(String specTag,
                                           String aggFunction,
                                           String columnNamesTag,
                                           String innerColNamesTag,
                                           String filterSpec,
                                           String sortClause,
                                           String verbose)
                                    throws IfsException
```
    Shows the list of distinct values of the specified AuditEvent columns, along with an optional aggregate function.
    Automatically includes a search condition to only include audit events that were created after the ID established via a call to markCurrentAuditingId.
    
    Parameters:
    
    specTag - the AuditSpecification tag
    
    aggFunction - the SQL aggregate function (can be null)
    
    columnNamesTag - the audit table column names to select
    
    innerColNamesTag - the audit table column names to use in the inner select; if null, no inner select is used
    
    filterSpec - search condition
    
    sortClause - how the events should be sorted
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditCertificates
```
public void showAuditCertificates(String objTags,
                                  String verbose)
                           throws IfsException
```
    Shows audit certificates for the array of object tags specified.
    
    Parameters:
    
    objTags - set of object tags
    
    verbose - should output be verbose?
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditEventOperationTypes
```
public void showAuditEventOperationTypes(String opTypeKeys)
                                  throws IfsException
```
    Converts a set of audit operation code keys to their numeric equivalents, and shows them.
    
    Parameters:
    
    opTypeKeys - set of operation type keys
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditTypesForClass
```
public void showAuditTypesForClass(String className)
                            throws IfsException
```
    Shows the set of audit operation types that are applicable to the class specified.
    
    Parameters:
    
    className - class name for which to show audit type
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditTypesUnderClass
```
public void showAuditTypesUnderClass(String className)
                              throws IfsException
```
    Shows the set of audit operation types that are applicable to the specified class, or any of the classes considered to descend from the specified class.
    
    Parameters:
    
    className - class name for which to show audit type
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditTypesForCreateOperations
```
public void showAuditTypesForCreateOperations()
                                       throws IfsException
```
    Shows the set of audit operation types that represent "created" operations.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditTypesForFreeOperations
```
public void showAuditTypesForFreeOperations()
                                     throws IfsException
```
    Shows the set of audit operation types that represent "free" operations.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - unregisterAuditEventType
```
public void unregisterAuditEventType(String opTypeKey)
                              throws IfsException
```
    Unregisters an audit event type.
    
    Parameters:
    
    opTypeKey - the audit event key to unregister
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - registerAuditEventType
```
public void registerAuditEventType(String opTypeKey,
                                   String targetCodeVal,
                                   String targetClass,
                                   String opCodeVal)
                            throws IfsException
```
    Registers an audit event type.
    
    Parameters:
    
    opTypeKey - the audit event key to register (e.g. "DOCUMENT_ACL_ASSIGNED")
    
    targetCodeVal - the event target code value (integer); caller must ensure that it matches of the values defined in AuditEventTypeRegistrations
    
    targetClass - the target class name (e.g. "DOCUMENT")
    
    opCodeVal - the operation code value (integer); caller must ensure that it matches of the values defined in AuditEventTypeRegistrations
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - registerAuditEventType
```
public void registerAuditEventType(String opTypeKey,
                                   String targetCodeVal,
                                   String targetClass,
                                   String opCodeVal,
                                   String createOrFreeVal)
                            throws IfsException
```
    Registers an audit event type.
    
    Parameters:
    
    opTypeKey - the audit event key to register (e.g. "DOCUMENT_ACL_ASSIGNED")
    
    targetCodeVal - the event target code value (integer); caller must ensure that it matches of the values defined in AuditEventTypeRegistrations
    
    targetClass - the target class name (e.g. "DOCUMENT")
    
    opCodeVal - the operation code value (integer); caller must ensure that it matches of the values defined in AuditEventTypeRegistrations
    
    createOrFreeVal - the value of whether the event is a create or free event, neither indicated by null (boolean)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showCustomAuditTypes
```
public void showCustomAuditTypes()
                          throws IfsException
```
    Shows the set of custom audit operation types.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - registerCustomAuditType
```
public void registerCustomAuditType(String opCodeKey,
                                    String targetClass)
                             throws IfsException
```
    Registers a custom audit event type.
    This will generate a operation type key from the arguments specified. For example, if opCodeKey is specified as "FAXED" and targetClass is specified as "DOCUMENT", the new operation type "DOCUMENT__FAXED" will get registered. The double underscores is intentional, and is used to distinguish between custom and non-custom event types.
    If the audit event type is already registered, the call has no effect, but will not result in an exception.
    
    Parameters:
    
    opCodeKey - the operation code key; the suffix for the new type
    
    targetClass - the target class
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - unregisterCustomAuditType
```
public void unregisterCustomAuditType(String opCodeKey,
                                      String targetClass)
                               throws IfsException
```
    Unregisters a custom audit event type.
    If the specified audit event type is not registered, the call has no effect, but will not result in an exception.
    
    Parameters:
    
    opCodeKey - the operation code key; the suffix for the new type
    
    targetClass - the target class
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - registerAllNonCustomAuditTypes
```
public void registerAllNonCustomAuditTypes()
                                    throws IfsException
```
    Registers all non-Custom audit event types.
    Subclasses (e.g. EcmScriptOperations) may override to register application-specific non-custom audit event types.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAuditTypeList
```
public void createAuditTypeList(String atlTag,
                                String atlDefTag)
                         throws IfsException
```
    Creates an audit type list.
    
    Parameters:
    
    atlTag - tag for the newly created AuditTypeList
    
    atlDefTag - definition tag to be used for new AuditTypeList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAuditTypeList
```
public void createAuditTypeList(AttributeValueTable avt)
                         throws IfsException
```
    Creates an audit type list.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created AuditTypeList
    - NAME: the AuditTypeList name (optional)
    - EVENTS: the declaration of Events for this AuditTypeList
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAndApplyAuditTypeList
```
public void createAndApplyAuditTypeList(String specTag,
                                        String atlDefTag)
                                 throws IfsException
```
    Creates an audit type list.
    NOTE: this should not be used for the GlobalAuditSpecification.
    
    Parameters:
    
    specTag - tag for the AuditSpecification to update
    
    atlDefTag - definition tag to be used for new AuditTypeList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAuditTypeList
```
public void identifyAuditTypeList(String tag,
                                  String atlName)
                           throws IfsException
```
    Identify an audit type list by name.
    
    Parameters:
    
    tag - tag tag to use to identify the object
    
    atlName - name of the AuditTypeList to find
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAuditTypeListBySpecification
```
public void identifyAuditTypeListBySpecification(String tag,
                                                 String specName)
                                          throws IfsException
```
    Identify an AuditTypeList by the AuditSpecification name.
    
    Parameters:
    
    tag - tag to use to identify the ATL
    
    specName - name of the AuditSpecification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditTypeList
```
public void showAuditTypeList(String objectTag)
                       throws IfsException
```
    Shows the audit type list corresponding to the supplied tag.
    
    Parameters:
    
    objectTag - tag for the audit list to be shown
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showExpandedAuditTypeList
```
public void showExpandedAuditTypeList(String objectTag,
                                      String className)
                               throws IfsException
```
    Shows the expanded audit type list corresponding to the supplied tag, and the specified class.
    The list is expanded to include placeholder entries for all event type that are applicable to the specified class, but do not appear in the list of AuditTypeEntries for the AuditTypeList.
    
    Parameters:
    
    objectTag - tag for the audit list to be shown
    
    className - class name for which to include placeholder entries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAuditSpecification
```
public void createAuditSpecification(String objectTag,
                                     String defTag)
                              throws IfsException
```
    Creates an AuditSpecification using the supplied definition.
    
    Parameters:
    
    objectTag - tag for the object
    
    defTag - definition tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAuditSpecification
```
public void identifyAuditSpecification(String tag,
                                       String asName)
                                throws IfsException
```
    Identify an audit specification by name.
    
    Parameters:
    
    tag - tag to use to identify the object
    
    asName - name of the AuditSpecification to find
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - lookupAuditSpecification
```
protected AuditSpecification lookupAuditSpecification(LibrarySession sess,
                                                      String tagOrName)
                                               throws IfsException
```
    Lookup a AuditSpecification by the specified name.
    Try to lookup the object using the specified string as the object tag, and if that fails attempt a lookup by name.
    
    Parameters:
    
    sess - handle to the current session
    
    tagOrName - AuditSpecification tag or name
    
    Returns:
    
    the AuditSpecification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAuditHandlerSpecification
```
public void identifyAuditHandlerSpecification(String tag,
                                              String specName)
                                       throws IfsException
```
    Identify an audit handler specification by the AuditSpecification name.
    
    Parameters:
    
    tag - tag to use to identify the object
    
    specName - name of the AuditSpecification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAuditTargetSpecification
```
public void identifyAuditTargetSpecification(String tag,
                                             String specName)
                                      throws IfsException
```
    Identify an audit target specification by the AuditSpecification name.
    
    Parameters:
    
    tag - tag to use to identify the object
    
    specName - name of the AuditSpecification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyGlobalAuditSpecification
```
public void identifyGlobalAuditSpecification(String tag)
                                      throws IfsException
```
    Identify the Global Audit History audit specification.
    
    Parameters:
    
    tag - tag to use to identify the object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyObjectAuditSpecification
```
public void identifyObjectAuditSpecification(String tag)
                                      throws IfsException
```
    Identify the Object Audit History audit specification.
    
    Parameters:
    
    tag - tag to use to identify the object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAuditSpecification
```
public void showAuditSpecification(String objectTag)
                            throws IfsException
```
    Shows the audit specification corresponding to the supplied tag.
    
    Parameters:
    
    objectTag - tag for the audit specification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllCustomAuditSpecifications
```
public void showAllCustomAuditSpecifications()
                                      throws IfsException
```
    Shows all of the custom audit specifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGlobalAuditSpecification
```
public void showGlobalAuditSpecification()
                                  throws IfsException
```
    Shows the Global audit spec.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showObjectAuditSpecification
```
public void showObjectAuditSpecification()
                                  throws IfsException
```
    Shows the Global audit spec.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAuditTypeListDefinition
```
public void defineAuditTypeListDefinition(String defTag)
                                   throws IfsException
```
    Creates an unnamed AuditTypeList definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAuditTypeListDefinition
```
public void defineAuditTypeListDefinition(String defTag,
                                          String name)
                                   throws IfsException
```
    Creates an AuditTypeList definition, with an optional name.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    name - the name to use for the new AuditTypeList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addAuditTypesForClass
```
public void addAuditTypesForClass(String defTag,
                                  String className,
                                  String mode)
                           throws IfsException
```
    Adds types to an AuditTypeList definition for a class.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    className - class name whose event types are to be added
    
    mode - success mode value to be added for each type
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addAuditType
```
public void addAuditType(String defTag,
                         String eventType,
                         String mode)
                  throws IfsException
```
    Adds an event type to an AuditTypeList definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    eventType - the event type to be added
    
    mode - success mode value to be added for each type
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAuditTargetSpecificationDefinition
```
public void defineAuditTargetSpecificationDefinition(String defTag,
                                                     String target,
                                                     String descendOpt)
                                              throws IfsException
```
    Defines an AuditTargetSpecification definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    target - the target object
    
    descendOpt - the descendents option
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAuditHandlerSpecificationDefinition
```
public void defineAuditHandlerSpecificationDefinition(String defTag,
                                                      String handlerClass,
                                                      String timerPeriod,
                                                      String timerBaseTime,
                                                      String notifiedOnEvent)
                                               throws IfsException
```
    Defines an AuditHandlerSpecification definition.
    Defaults the handler type and does not use a specific Agent identifier.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    handlerClass - the fully qualified handler class
    
    timerPeriod - the timer period (can be null)
    
    timerBaseTime - the base time of day (can be null)
    
    notifiedOnEvent - whether the handler is to be notified upon a new event
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAuditHandlerSpecificationDefinition
```
public void defineAuditHandlerSpecificationDefinition(String defTag,
                                                      String handlerClass,
                                                      String timerPeriod,
                                                      String timerBaseTime,
                                                      String notifiedOnEvent,
                                                      String handlerType,
                                                      String rtClassif)
                                               throws IfsException
```
    Defines an AuditHandlerSpecification definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    handlerClass - the fully qualified handler class
    
    timerPeriod - the timer period (can be null)
    
    timerBaseTime - the base time of day (can be null)
    
    notifiedOnEvent - whether the handler is to be notified upon a new event
    
    handlerType - the handler type (can be null)
    
    rtClassif - the runtime classification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addStringHandlerProperty
```
public void addStringHandlerProperty(String defTag,
                                     String propName,
                                     String propValue)
                              throws IfsException
```
    Deprecated. 9.0.4.6: use addDefinitionProperty
    
    Adds a String type handler property to the specified handler definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    propName - the property name
    
    propValue - the property value
    
    Throws:
    
    IfsException - if the operation fails
  - addBooleanHandlerProperty
```
public void addBooleanHandlerProperty(String defTag,
                                      String propName,
                                      String propValue)
                               throws IfsException
```
    Deprecated. 9.0.4.6: use addDefinitionProperty
    
    Adds a Boolean type handler property to the specified handler definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    propName - the property name
    
    propValue - the property value
    
    Throws:
    
    IfsException - if the operation fails
  - addIntegerHandlerProperty
```
public void addIntegerHandlerProperty(String defTag,
                                      String propName,
                                      String propValue)
                               throws IfsException
```
    Deprecated. 9.0.4.6: use addDefinitionProperty
    
    Adds a Integer type handler property to the specified handler definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    propName - the property name
    
    propValue - the property value
    
    Throws:
    
    IfsException - if the operation fails
  - addLongHandlerProperty
```
public void addLongHandlerProperty(String defTag,
                                   String propName,
                                   String propValue)
                            throws IfsException
```
    Deprecated. 9.0.4.6: use addDefinitionProperty
    
    Adds a Long type handler property to the specified handler definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    propName - the property name
    
    propValue - the property value
    
    Throws:
    
    IfsException - if the operation fails
  - addStringArrayHandlerProperty
```
public void addStringArrayHandlerProperty(String defTag,
                                          String propName,
                                          String propValue)
                                   throws IfsException
```
    Deprecated. 9.0.4.6: use addDefinitionProperty
    
    Adds a String arrray type handler property to the specified handler definition.
    
    Parameters:
    
    defTag - the tag to use to identify the definition
    
    propName - the property name
    
    propValue - the property value
    
    Throws:
    
    IfsException - if the operation fails
  - createAuditSpecification
```
public void createAuditSpecification(String specName,
                                     String atlDefTag,
                                     String atsDefTag,
                                     String ahsDefTag,
                                     String specDesc)
                              throws IfsException
```
    Creates a new AuditSpecification.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    atlDefTag - the AuditTypeList definition tag
    
    atsDefTag - the AuditTargetSpecification definition tag
    
    ahsDefTag - the AuditHandlerSpecification definition tag
    
    specDesc - the AuditSpecification description
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAuditSpecification
```
public void createAuditSpecification(String specName,
                                     String atlDefTag,
                                     String atsDefTag,
                                     String ahsDefTag,
                                     String specDesc,
                                     String userSearch)
                              throws IfsException
```
    Creates a new AuditSpecification.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    atlDefTag - the AuditTypeList definition tag
    
    atsDefTag - the AuditTargetSpecification definition tag
    
    ahsDefTag - the AuditHandlerSpecification definition tag
    
    specDesc - the AuditSpecification description
    
    userSearch - whether the AuditSpecification history should be searchable by regular users
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAuditSpecification
```
public void createAuditSpecification(AttributeValueTable avt)
                              throws IfsException
```
    Creates a new AuditSpecification.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created Format
    - NAME: the AuditSpecification name
    - DESCRIPTION: the AuditSpecification description
    - AUDITTYPELISTDEFINITIONTAG: the tag that identifies the AuditTypeList definition
    - AUDITTARGETSPECIFICATIONDEFINITIONTAG: the tag that identifies the AuditTargetSpecification definition
    - AUDITHANDLERSPECIFICATIONDEFINITIONTAG: the tag that identifies the AuditHandlerSpecification definition
    - USERSEARCHABLE: whether the audit history will be searchable by users
    - TABLENAMESUFFIX: the table name suffix to use for the audit event table
    - PRIVATEPROPERTYTABLEUSED: whether a private property table should be used
    - ACTIVE: whether the newly created AuditSpecification should be Active
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createEntireAuditSpecification
```
public void createEntireAuditSpecification(AttributeValueTable avt)
                                    throws IfsException
```
    Creates a new AuditSpecification entirely, using embeeded definitions for the AuditTypeList, AuditTargetSpecification, and AuditHandlerSpecification.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created AuditSpecification
    - NAME: the AuditSpecification name
    - DESCRIPTION: the AuditSpecification description
    - AUDITTYPELIST: the settings for the AuditTypeList
    - AUDITTARGETSPECIFICATION: the settings for the AuditTargetSpecification
    - AUDITHANDLERSPECIFICATION: the settings for the AuditHandlerSpecification
    - USERSEARCHABLE: whether the audit history will be searchable by users
    - TABLENAMESUFFIX: the table name suffix to use for the audit event table
    - PRIVATEPROPERTYTABLEUSED: whether a private property table should be used
    - PROPERTIES: Properties to be added to the new object's PropertyBundle
    - ACTIVE: whether the newly created AuditSpecification should be Active
    - FREEEXISTINGOBJECT: whether to free an existing object with the same name
    - SKIPIFEXISTS: whether to skip the creation request if an object exists with the same name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - activateAuditSpecification
```
public void activateAuditSpecification(String specName)
                                throws IfsException
```
    Sets an AuditSpecification to an active state.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deactivateAuditSpecification
```
public void deactivateAuditSpecification(String specName)
                                  throws IfsException
```
    Sets an AuditSpecification to an inactive state.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - activateAuditHandlerSpecification
```
public void activateAuditHandlerSpecification(String specName)
                                       throws IfsException
```
    Sets an AuditSpecificationHandler to an active state.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deactivateAuditHandlerSpecification
```
public void deactivateAuditHandlerSpecification(String specName)
                                         throws IfsException
```
    Sets an AuditSpecificationHandler to an inactive state.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deleteAuditSpecification
```
public void deleteAuditSpecification(String specName)
                              throws IfsException
```
    Deletes an AuditSpecification.
    If no AuditSpecification is found with the specified name, displays a log message indicating this without throwing an exception.
    
    Parameters:
    
    specName - the AuditSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - lookupAuditDomainContext
```
protected Folder lookupAuditDomainContext(LibrarySession sess,
                                          String tag)
                                   throws IfsException
```
    Lookup the Audit Domain context by Tag.
    Simply return the root folder, regardless of the tag value specified. This behavior may change in the future, if multiple domain concepts are possible in CORE.
    
    Parameters:
    
    sess - the session context
    
    tag - the tag that identified the Domain object
    
    Returns:
    
    the Audit Domain context
    
    Throws:
    
    IfsException - if the operation fails
  - setAuditingStartingId
```
protected void setAuditingStartingId(long auditId)
```
    Set the starting point for Audit searches.
    
    Parameters:
    
    auditId - the highest Audit ID that currently exists.
    
    (Published)
  - getAuditingStartingId
```
protected long getAuditingStartingId()
```
    Get the value previously set as the starting point for Audit searches.
    
    Returns:
    
    the Audit ID to use as the base for audit searches
    
    (Published)
  - getAuditEventDispatcher
```
protected AuditEventDispatcher getAuditEventDispatcher(LibrarySession sess)
                                                throws IfsException
```
    Get the AuditEventDispatcher.
    
    Parameters:
    
    sess - the session
    
    Returns:
    
    the AuditEventDispatcher
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createServerSpecification
```
public void createServerSpecification(AttributeValueTable avt)
                               throws IfsException
```
    Creates a new ServerSpecification entirely, using embeeded definitions.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the name
    - DESCRIPTION: the description
    - SERVERCONFIGURATION: the ServerConfiguration
    - ACTIVE: whether the newly created object should be Active
    - SETTINGS: any detailed settings for the new object
    - FREEEXISTINGOBJECT: whether to free an existing object with the same name
    - SKIPIFEXISTS: whether to skip the creation request if an object exists with the same name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyServerSpecification
```
public void identifyServerSpecification(String specTag,
                                        String specName)
                                 throws IfsException
```
    Identify a ServerSpecification by its unique name.
    
    Parameters:
    
    specTag - the ServerSpecification tag
    
    specName - the ServerSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServerSpecification
```
public void showServerSpecification(String specTag)
                             throws IfsException
```
    Show details about a ServerSpecification.
    
    Parameters:
    
    specTag - the ServerSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllServerSpecifications
```
public void showAllServerSpecifications()
                                 throws IfsException
```
    Shows all of the ServerSpecifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - activateServerSpecification
```
public void activateServerSpecification(String specName)
                                 throws IfsException
```
    Sets an ServerSpecification to an active state.
    
    Parameters:
    
    specName - the ServerSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deactivateServerSpecification
```
public void deactivateServerSpecification(String specName)
                                   throws IfsException
```
    Sets an ServerSpecification to an inactive state.
    
    Parameters:
    
    specName - the ServerSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createServiceConfiguration
```
public void createServiceConfiguration(String tag,
                                       String name,
                                       String likeTag,
                                       String defTag)
                                throws IfsException
```
    Create a ServiceConfiguration.
    
    Parameters:
    
    tag - the ServiceConfiguration tag to use for the new object
    
    name - the ServiceConfiguration name
    
    likeTag - a ServiceConfiguration tag identifying the SC that the new object will be "like"
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createServiceConfiguration
```
public void createServiceConfiguration(AttributeValueTable avt)
                                throws IfsException
```
    Create a ServiceConfiguration.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ServiceConfiguration
    - DEFTAG: the definition tag that holds property settings
    - NAME: the ServiceConfiguration name
    - LIKESERVICECONFIGURATIONTAG: the tag that identifies the ServiceConfiguration that the new instance is based on
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyServiceConfiguration
```
public void identifyServiceConfiguration(String scTag,
                                         String scName)
                                  throws IfsException
```
    Identify a ServiceConfiguration by its unique name.
    
    Parameters:
    
    scTag - the ServiceConfiguration tag
    
    scName - the ServiceConfiguration name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServiceConfiguration
```
public void showServiceConfiguration(String scTag)
                              throws IfsException
```
    Show details about a ServiceConfiguration.
    
    Parameters:
    
    scTag - the ServiceConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServiceConfiguration
```
public void showServiceConfiguration(String scTag,
                                     String verboseVal)
                              throws IfsException
```
    Show details about a ServiceConfiguration.
    
    Parameters:
    
    scTag - the ServiceConfiguration tag
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllServiceConfigurations
```
public void showAllServiceConfigurations()
                                  throws IfsException
```
    Shows all of the ServiceConfiguration instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllServiceConfigurations
```
public void showAllServiceConfigurations(String verboseVal)
                                  throws IfsException
```
    Shows all of the ServiceConfiguration instances.
    
    Parameters:
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateServiceConfiguration
```
public void updateServiceConfiguration(String svcTag,
                                       String defTag)
                                throws IfsException
```
    Update a ServiceConfiguration.
    
    Parameters:
    
    svcTag - the tag that identifies the ServiceConfiguration
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateServiceConfiguration
```
public void updateServiceConfiguration(AttributeValueTable avt)
                                throws IfsException
```
    Update a ServiceConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the target ServiceConfiguration to update
    - DEFTAG: definition tag that holds property settings (optional)
    - SOURCETAG: tag that identifies a ServiceConfiguration whose properties should be copied to the target (optional)
    - SOURCENAME: Name of the ServiceConfiguration whose properties should be copied to the target (optional)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeServiceConfiguration
```
public void freeServiceConfiguration(String svcTag)
                              throws IfsException
```
    Free a ServiceConfiguration.
    
    Parameters:
    
    svcTag - the ServiceConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeServiceConfiguration
```
public void freeServiceConfiguration(AttributeValueTable avt)
                              throws IfsException
```
    Free a ServiceConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the ServiceConfiguration to free
    - NAME: name of the ServiceConfiguration to free
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createNodeConfiguration
```
public void createNodeConfiguration(String tag,
                                    String name,
                                    String ncSuperTag,
                                    String active,
                                    String defTag)
                             throws IfsException
```
    Create a NodeConfiguration.
    
    Parameters:
    
    tag - the NodeConfiguration tag to use for the new object
    
    name - the NodeConfiguration name
    
    ncSuperTag - a NodeConfiguration tag identifying the NC that the new object will extend
    
    active - is the new Node active? (boolean)
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createNodeConfiguration
```
public void createNodeConfiguration(AttributeValueTable avt)
                             throws IfsException
```
    Creates a NodeConfiguration.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created NodeConfiguration
    - DEFTAG: the definition tag that holds property settings
    - NAME: the NodeConfiguration name
    - ACTIVE: whether the NodeConfiguration is initially active (boolean)
    - SUPERNODECONFIGURATIONTAG: the tag that identifies the NodeConfiguration that the new instance extends
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addManagedServiceDeclaration
```
public void addManagedServiceDeclaration(String serviceName,
                                         String svcName,
                                         String activeVal)
                                  throws IfsException
```
    Add a Service declaration to the list being prepared as the set of managed Services, used in the next createNodeConfiguration operation.
    The Service declaration specified in this operation is saved into a list which is used in the next createNodeConfiguration operation. The list is then implicitly cleared.
    
    Parameters:
    
    serviceName - the Service name
    
    svcName - the ServiceConfiguration name
    
    activeVal - boolean value which indicates whether the service is active
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addManagedServiceDeclaration
```
public void addManagedServiceDeclaration(ScriptOperations.ServiceDefinition serviceDef)
                                  throws IfsException
```
    Add a Service declaration to the list being prepared as the set of managed Services, used in the next createNodeConfiguration operation.
    The Service declaration specified in this operation is saved into a list which is used in the next createNodeConfiguration operation. The list is then implicitly cleared.
    
    Parameters:
    
    serviceDef - the Service Declaration
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getManagedServiceDeclarations
```
public ScriptOperations.ServiceDefinition[] getManagedServiceDeclarations()
                                                                   throws IfsException
```
    Gets the managed Service declarations previously added via addManagedServiceDeclaration.
    The list is implicitly cleared by this call.
    
    Returns:
    
    the Service declarations
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addManagedServerDeclaration
```
public void addManagedServerDeclaration(String serverName,
                                        String scName,
                                        String serviceName,
                                        String activeVal,
                                        String startedVal,
                                        String priorityVal)
                                 throws IfsException
```
    Add a Server declaration to the list being prepared as the set of managed Servers, used in the next createNodeConfiguration operation.
    The Server declaration specified in this operation is saved into a list which is used in the next createNodeConfiguration operation. The list is then implicitly cleared.
    
    Parameters:
    
    serverName - the Server name, e.g. QuotaAgent
    
    scName - the ServerConfiguration name, e.g. QuotaAgentConfiguration
    
    serviceName - the service name; must match the service name of one of the managed Services
    
    activeVal - boolean value which indicates whether the server is active
    
    startedVal - boolean value which indicates whether the server should be initially started
    
    priorityVal - the initial Thread priority for the Server
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addManagedServerDeclaration
```
public void addManagedServerDeclaration(AttributeValueTable avt)
                                 throws IfsException
```
    Add a Server declaration to the list being prepared as the set of managed Servers, used in the next createNodeConfiguration operation.
    The Server declaration specified in this operation is saved into a list which is used in the next createNodeConfiguration operation. The list is then implicitly cleared.
    The keys supported by this operation:
    - SERVERNAME: the Server name
    - SERVERCONFIGURATIONNAME: the ServerConfiguration name
    - SERVICENAME: the Service name
    - OVERRIDESTAG: the tag of the definition that holds the ServerConfiguration overrides
    - ACTIVE: whether the Server is active (boolean)
    - STARTED: whether the Server should be initially started (boolean)
    - PRIORITY: the initial Thread priority for the Server
    - REPLACEPREVIOUSOVERRIDES: whether all previously specified Server overrides should be replace during an update operation (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addManagedServerDeclaration
```
public void addManagedServerDeclaration(ScriptOperations.ServerDefinition serverDef)
                                 throws IfsException
```
    Add a Server declaration to the list being prepared as the set of managed Servers, used in the next createNodeConfiguration operation.
    The Server declaration specified in this operation is saved into a list which is used in the next createNodeConfiguration operation. The list is then implicitly cleared.
    
    Parameters:
    
    serverDef - the Server Declaration
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getManagedServerDeclarations
```
public ScriptOperations.ServerDefinition[] getManagedServerDeclarations()
                                                                 throws IfsException
```
    Gets the managed Server declarations previously added via addManagedServerDeclaration.
    The list is implicitly cleared by this call.
    
    Returns:
    
    the Server declarations
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyNodeConfiguration
```
public void identifyNodeConfiguration(String ncTag,
                                      String ncName)
                               throws IfsException
```
    Identify a NodeConfiguration by its unique name.
    
    Parameters:
    
    ncTag - the NodeConfiguration tag
    
    ncName - the NodeConfiguration name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showNodeConfiguration
```
public void showNodeConfiguration(String ncTag)
                           throws IfsException
```
    Show details about a NodeConfiguration.
    
    Parameters:
    
    ncTag - the NodeConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showNodeConfiguration
```
public void showNodeConfiguration(String ncTag,
                                  String verboseVal)
                           throws IfsException
```
    Show details about a NodeConfiguration.
    
    Parameters:
    
    ncTag - the NodeConfiguration tag
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllNodeConfigurations
```
public void showAllNodeConfigurations()
                               throws IfsException
```
    Shows all of the NodeConfiguration instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllNodeConfigurations
```
public void showAllNodeConfigurations(String verboseVal)
                               throws IfsException
```
    Shows all of the NodeConfiguration instances.
    
    Parameters:
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateNodeConfiguration
```
public void updateNodeConfiguration(String ncTag,
                                    String defTag)
                             throws IfsException
```
    Update a NodeConfiguration.
    
    Parameters:
    
    ncTag - the tag that identifies the NodeConfiguration
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateNodeConfiguration
```
public void updateNodeConfiguration(AttributeValueTable avt)
                             throws IfsException
```
    Update a NodeConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the target NodeConfiguration to update
    - DEFTAG: definition tag that holds property settings (optional)
    - SERVERSTOREMOVE: names of the managed Servers that should be removed
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeServiceFromNodeConfiguration
```
public void removeServiceFromNodeConfiguration(String ncTag,
                                               String svName)
                                        throws IfsException
```
    Remove a Service registration from a NodeConfiguration.
    
    Parameters:
    
    ncTag - the tag that identifies the NodeConfiguration
    
    svName - the service name to remove
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeServerFromNodeConfiguration
```
public void removeServerFromNodeConfiguration(String ncTag,
                                              String sName)
                                       throws IfsException
```
    Remove a Server registration from a NodeConfiguration.
    
    Parameters:
    
    ncTag - the tag that identifies the NodeConfiguration
    
    sName - the server name to remove
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeNodeConfiguration
```
public void freeNodeConfiguration(String ncTag)
                           throws IfsException
```
    Free a NodeConfiguration.
    
    Parameters:
    
    ncTag - the NodeConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeNodeConfiguration
```
public void freeNodeConfiguration(AttributeValueTable avt)
                           throws IfsException
```
    Free a NodeConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the NodeConfiguration to free
    - NAME: name of the NodeConfiguration to free
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createServerConfiguration
```
public void createServerConfiguration(String tag,
                                      String name,
                                      String likeTag,
                                      String defTag)
                               throws IfsException
```
    Create a ServerConfiguration.
    
    Parameters:
    
    tag - the ServerConfiguration tag to use for the new object
    
    name - the ServerConfiguration name
    
    likeTag - a ServerConfiguration tag identifying the SC that the new object will be "like"
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createServerConfiguration
```
public void createServerConfiguration(AttributeValueTable avt)
                               throws IfsException
```
    Create a ServerConfiguration.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ServerConfiguration
    - DEFTAG: the definition tag that holds property settings
    - NAME: the ServerConfiguration name
    - LIKESERVERCONFIGURATIONTAG: the tag that identifies the ServerConfiguration that the new instance is based on
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyServerConfiguration
```
public void identifyServerConfiguration(String scTag,
                                        String scName)
                                 throws IfsException
```
    Identify a ServerConfiguration by its unique name.
    
    Parameters:
    
    scTag - the ServerConfiguration tag
    
    scName - the ServerConfiguration name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServerConfiguration
```
public void showServerConfiguration(String scTag)
                             throws IfsException
```
    Show details about a ServerConfiguration.
    
    Parameters:
    
    scTag - the ServerConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServerConfiguration
```
public void showServerConfiguration(String scTag,
                                    String verboseVal)
                             throws IfsException
```
    Show details about a ServerConfiguration.
    
    Parameters:
    
    scTag - the ServerConfiguration tag
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllServerConfigurations
```
public void showAllServerConfigurations()
                                 throws IfsException
```
    Shows all of the ServerConfiguration instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllServerConfigurations
```
public void showAllServerConfigurations(String verboseVal)
                                 throws IfsException
```
    Shows all of the ServerConfiguration instances.
    
    Parameters:
    
    verboseVal - boolean value that indcicates verbosity of output
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateServerConfiguration
```
public void updateServerConfiguration(String scTag,
                                      String defTag)
                               throws IfsException
```
    Update a ServerConfiguration.
    
    Parameters:
    
    scTag - the tag that identifies the ServerConfiguration
    
    defTag - tag identifying the Definition holding the properties
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateServerConfiguration
```
public void updateServerConfiguration(AttributeValueTable avt)
                               throws IfsException
```
    Update a ServerConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the target ServerConfiguration to update
    - DEFTAG: definition tag that holds property settings (optional)
    - SOURCETAG: tag that identifies a ServerConfiguration whose properties should be copied to the target (optional)
    - SOURCENAME: Name of the ServerConfiguration whose properties should be copied to the target (optional)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeServerConfiguration
```
public void freeServerConfiguration(String scTag)
                             throws IfsException
```
    Free a ServerConfiguration.
    
    Parameters:
    
    scTag - the ServerConfiguration tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeServerConfiguration
```
public void freeServerConfiguration(AttributeValueTable avt)
                             throws IfsException
```
    Free a ServerConfiguration.
    The keys supported by this operation:
    - TAG: tag that identifies the ServerConfiguration to free
    - NAME: name of the ServerConfiguration to free
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAclValueForConfigurationObjects
```
protected AttributeValue getAclValueForConfigurationObjects(LibrarySession sess)
                                                     throws IfsException
```
    Get the ACL value to use for Configuration object creation.
    
    Parameters:
    
    sess - the session context
    
    Returns:
    
    the AttributeValue reflecting the desired ACL
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - convertPropertyDefinitionsToHashtable
```
protected Hashtable convertPropertyDefinitionsToHashtable(PropertyDefinition[] pbDefs)
                                                   throws IfsException
```
    Convert an array of PropertyDefinitions to a Hashtable, keyed by the property name, with the value being an AttributeValue representation of the property's value.
    
    Parameters:
    
    pbDefs - the PropertyDefinitions
    
    Returns:
    
    a Hashtable equivalent
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyByAttribute
```
public void identifyByAttribute(String identifiedTag,
                                String objectTag,
                                String attrName)
                         throws IfsException
```
    Identify an object as an attribute of another object.
    
    Parameters:
    
    identifiedTag - the tag that will identify the object referenced by the attribute of the specified object
    
    objectTag - the specified object tag
    
    attrName - the name of the attribute
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAttribute
```
public void showAttribute(String objectTag,
                          String attrName)
                   throws IfsException
```
    Show the attribute value of an object.
    
    Parameters:
    
    objectTag - the specified object tag
    
    attrName - the name of the attribute
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createUser
```
public void createUser(AttributeValueTable avt)
                throws IfsException
```
    Creates a User.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created DirectoryUser
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    - NAME: the User name
    - PASSWORD: the User password
    - CREDENTIALMANAGER: the Credential Manager (e.g. "Ifs")
    - DISTINGUISHEDNAME: the Distinguished name for the user
    - CREATECREDENTIALMANAGERUSER: whether the Credential Manager user is to be created
    - PASSWORDCHANGEABLE: whether the User password is changeable
    - ADMINENABLED: whether the User can enter admin mode
    - SYSTEMADMINENABLED: whether the User can enter system admin mode
    - CREATEPRIMARYUSERPROFILE: whether the PrimaryUserProfile is created
    - CREATEHOMEFOLDER: whether the Home folder is created
    - CREATECONTENTQUOTA: whether the ContentQuota is created
    - CONTENTQUOTAENABLED: whether the ContentQuota is enabled
    - CONTENTQUOTAALLOCATEDSTORAGE: the quota allocation (Long)
    - HOMEFOLDERROOT: the abolute path to the folder which will be the Home folder's parent (e.g. "/home")
    - HOMEFOLDERNAME: the name of the Home folder
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setUserCreateOptions
```
protected void setUserCreateOptions(AttributeValueTable avt,
                                    Hashtable ht)
                             throws IfsException
```
    Sets options for user creation on the specified options Hashtable. The keys supported by this operation:
    - CREDENTIALMANAGER: the Credential Manager (e.g. "Ifs")
    - DISTINGUISHEDNAME: the Distinguished name for the user
    - CREATECREDENTIALMANAGERUSER: whether the Credential Manager user is to be created
    - PASSWORDCHANGEABLE: whether the User password is changeable
    - ADMINENABLED: whether the User can enter admin mode
    - SYSTEMADMINENABLED: whether the User can enter system admin mode
    - CREATEPRIMARYUSERPROFILE: whether the PrimaryUserProfile is created
    - CREATEHOMEFOLDER: whether the Home folder is created
    - CREATECONTENTQUOTA: whether the ContentQuota is created
    - CONTENTQUOTAENABLED: whether the ContentQuota is enabled
    - CONTENTQUOTAALLOCATEDSTORAGE: the quota allocation (Long)
    - HOMEFOLDERROOT: the abolute path to the folder which will be the Home folder's parent (e.g. "/home")
    - HOMEFOLDERNAME: the name of the Home folder
    - TIMEZONE: the Timezone preferred by the user
    - LANGUAGE: the language preferred by the user
    - CHARACTERSET: the character set preferred by the user
    - LOCALE: the Locale preferred by the user
    - DISPLAYNAME: the display name for the user
    Parameters:
    
    avt - the named arguments specified in createUser
    
    ht - the options Hashtable
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateUserPassword
```
public void updateUserPassword(AttributeValueTable avt)
                        throws IfsException
```
    Updates the password for a User.
    The keys supported by this operation:
    - USERNAME: the name of the DirectoryUser to update
    - TAG: the tag that identifies the DirectoryUser to update
    - PASSWORD: the new User password
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deleteUser
```
public void deleteUser(AttributeValueTable avt)
                throws IfsException
```
    Deletes a User.
    The keys supported by this operation:
    - TAG: the tag that identifies the DirectoryUser to update
    - DELETECREDENTIALMANAGERUSER: whether the Credential Manager user should be deleted
    - DELETEHOMEFOLDER: whether the Home folder should be deleted
    - REASSIGNOWNERSHIP: whether objects owned by the deleted user should have a new Owner assigned
    - NEWOWNERNAME: the name of the new Owner, if REASSIGNOWNERSHIP is true
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setUserDeleteOptions
```
protected void setUserDeleteOptions(AttributeValueTable avt,
                                    Hashtable ht)
                             throws IfsException
```
    Sets options for user delete on the specified options Hashtable.
    The keys supported by this operation:
    - TAG: the tag that identifies the DirectoryUser to update
    - DELETECREDENTIALMANAGERUSER: whether the Credential Manager user should be deleted
    - DELETEHOMEFOLDER: whether the Home folder should be deleted
    - REASSIGNOWNERSHIP: whether objects owned by the deleted user should have a new Owner assigned
    - NEWOWNERNAME: the name of the new Owner, if REASSIGNOWNERSHIP is true
    Parameters:
    
    avt - the named arguments specified in deleteUser
    
    ht - the options Hashtable
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyUser
```
public void identifyUser(String userTag,
                         String userName)
                  throws IfsException
```
    Lookup a user by name and register it.
    
    Parameters:
    
    userTag - the tag to be used for the user
    
    userName - the user name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifySystemUser
```
public void identifySystemUser(String sysTag)
                        throws IfsException
```
    Lookup the SYSTEM user and register it.
    
    Parameters:
    
    sysTag - the tag to be used for the SYSTEM user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyGuestUser
```
public void identifyGuestUser(String guestTag)
                       throws IfsException
```
    Lookup the GUEST user and register it.
    
    Parameters:
    
    guestTag - the tag to be used for the GUEST user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyPrimaryUserProfile
```
public void identifyPrimaryUserProfile(String pupTag,
                                       String userName)
                                throws IfsException
```
    Identify the PrimaryUserProfile for a user.
    
    Parameters:
    
    pupTag - the tag to be used for the PrimaryUserProfile
    
    userName - the user name or tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setUserDefaultAcl
```
public void setUserDefaultAcl(String aclName,
                              String userName)
                       throws IfsException
```
    Sets the users default ACL for new created POs.
    
    Parameters:
    
    aclName - the new AccessControlList
    
    userName - the name of the user
    
    Throws:
    
    IfsException - if opertaion fails
  - createExtendedUserProfile
```
public void createExtendedUserProfile(AttributeValueTable avt)
                               throws IfsException
```
    Creates an ExtendedUserProfile.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the name of the new object
    - USERNAME: the user this object is associated with
    - APPLICATION: the token value (uniquely identifies token)
    - SKIPIFEXISTS: whether to skip creation if an object with a matching token value already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createGroup
```
public void createGroup(AttributeValueTable avt)
                 throws IfsException
```
    Creates a DirectoryGroup.
    The keys supported by this operation:
    - TAG: the tag that will identify the new object
    - NAME: the group name
    - DESCRIPTION: the group description
    - ACL: the ACL to use for the new group
    - DEFTAG: a DirectoryGroupDefinition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyGroup
```
public void identifyGroup(AttributeValueTable avt)
                   throws IfsException
```
    Identify a Group by name and optionally class.
    The keys supported by this operation:
    - TAG: the tag that will identify the Group
    - NAME: the group name
    - CLASS: the ClassObject of the group (optional).
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - addGroupMember
```
public void addGroupMember(AttributeValueTable avt)
                    throws IfsException
```
    Adds a member to a DirectoryGroup.
    The keys supported by this operation:
    - TAG: the tag that identifies the group to be modified
    - USERMEMBER: the name or tag of the user to add as a single member
    - GROUPMEMBERTAG: the tag of the group to be added as a single member
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addGroupMembers
```
public void addGroupMembers(AttributeValueTable avt)
                     throws IfsException
```
    Adds members to a DirectoryGroup.
    The keys supported by this operation:
    - TAG: the tag that identifies the group to be modified
    - USERMEMBERS: the names or tags of the users to add as members
    - GROUPMEMBERS: the tags of the groups to add as members
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeGroupMembers
```
public void removeGroupMembers(AttributeValueTable avt)
                        throws IfsException
```
    Removes members from a DirectoryGroup.
    The keys supported by this operation:
    - TAG: the tag that identifies the group to be modified
    - USERMEMBERS: the names or tags of the users to remove as members
    - GROUPMEMBERS: the tags of the groups to remove as members
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyWorldGroup
```
public void identifyWorldGroup(String worldTag)
                        throws IfsException
```
    Lookup the "WORLD" group and register it.
    
    Parameters:
    
    worldTag - the tag to be used for the WORLD group
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGroup
```
public void showGroup(String groupTag)
               throws IfsException
```
    Show details about a group. Can be used for internal groups (e.g. the "all users" group)
    
    Parameters:
    
    groupTag - the target group tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrCreateCompositeGroup
```
public void findOrCreateCompositeGroup(AttributeValueTable avt)
                                throws IfsException
```
    Find or create a CompositeGroup.
    The keys supported by this operation:
    - TAG: the tag that will identify the new CompositeGroup
    - MEMBERSHIP: a set of group tags representing the membership
    - NAME: the CompositeGroup name (optional)
    - DESCRIPTION: the CompositeGroup description (optional)
    - ACL: the ACL to use for the new group (optional)
    - DEFTAG: optional tag for definition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyCompositeGroup
```
public void identifyCompositeGroup(AttributeValueTable avt)
                            throws IfsException
```
    Identify a CompositeGroup by its membership.
    The keys supported by this operation:
    - TAG: the tag that will identify the CompositeGroup
    - MEMBERSHIP: a set of group tags
    - DEFTAG: optional tag for definition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - showCompositeGroup
```
public void showCompositeGroup(String groupTag)
                        throws IfsException
```
    Show details about a CompositeGroup.
    
    Parameters:
    
    groupTag - the CompositeGroup tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showServiceStatistics
```
public void showServiceStatistics()
                           throws IfsException
```
    Show the current service statistics.
    This will show the following statistics:
    - Runtime Statistics
    - DataCache Statistics
    - AclCache Statistics
    - ReadonlyConnectionPool Statistics
    - WriteableConnectionPool Statistics
    - Clustering Statistics
    - Session Statistics
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showSessionCacheStatistics
```
public void showSessionCacheStatistics()
                                throws IfsException
```
    Show session cache statistics for the current session.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showRuntimeStatistics
```
public void showRuntimeStatistics()
                           throws IfsException
```
    Show runtime statistics for the current JVM.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setRepositoryParameter
```
public void setRepositoryParameter(AttributeValueTable avt)
                            throws IfsException
```
    Sets a repository parameter.
    The keys supported by this operation:
    - ParameterName: the repository parameter name
    - Value: the repository parameter value (always a String)
    - Encrypted: whether the value should be stored encypted (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deleteRepositoryParameter
```
public void deleteRepositoryParameter(AttributeValueTable avt)
                               throws IfsException
```
    Deletes a repository parameter.
    The keys supported by this operation:
    - ParameterName: the repository parameter name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showRepositoryParameter
```
public void showRepositoryParameter(AttributeValueTable avt)
                             throws IfsException
```
    Shows a repository parameter.
    The keys supported by this operation:
    - ParameterName: the repository parameter name
    - Encrypted: whether the value is stored encypted (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllRepositoryParameters
```
public void showAllRepositoryParameters()
                                 throws IfsException
```
    Shows all repository parameters.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyInstancePropertyBundle
```
public void identifyInstancePropertyBundle(String pbTag)
                                    throws IfsException
```
    Identify the "Instance PropertyBundle", also known as the Domain PropertyBundle.
    
    Parameters:
    
    pbTag - the tag to use
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showInstancePropertyBundle
```
public void showInstancePropertyBundle()
                                throws IfsException
```
    Show the instance PropertyBundle.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showInstanceProperty
```
public void showInstanceProperty(String key)
                          throws IfsException
```
    Show an instance property.
    
    Parameters:
    
    key - the instance property key
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setInstanceProperty
```
public void setInstanceProperty(AttributeValueTable avt)
                         throws IfsException
```
    Sets an "instance" property, i.e. a property in the Domain PropertyBundle.
    The keys supported by this operation:
    - PROPERTYNAME (or KEY or NAME): the domain property name
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - setStringInstanceProperty
```
public void setStringInstanceProperty(String key,
                                      String value)
                               throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is a String
    
    Parameters:
    
    key - the instance property key
    
    value - the instance property value (representing a String)
    
    Throws:
    
    IfsException - if the operation fails
  - setBooleanInstanceProperty
```
public void setBooleanInstanceProperty(String key,
                                       String value)
                                throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is a boolean
    
    Parameters:
    
    key - the instance property key
    
    value - the instance property value (representing a boolean)
    
    Throws:
    
    IfsException - if the operation fails
  - setIntegerInstanceProperty
```
public void setIntegerInstanceProperty(String key,
                                       String value)
                                throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is an integer
    
    Parameters:
    
    key - the instance property key
    
    value - the instance property value (representing an integer)
    
    Throws:
    
    IfsException - if the operation fails
  - setLongInstanceProperty
```
public void setLongInstanceProperty(String key,
                                    String value)
                             throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is a long integer
    
    Parameters:
    
    key - the instance property key
    
    value - the instance property value (representing a long)
    
    Throws:
    
    IfsException - if the operation fails
  - setPublicObjectInstanceProperty
```
public void setPublicObjectInstanceProperty(String key,
                                            String tag)
                                     throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is a PublicObject, identified by tag.
    
    Parameters:
    
    key - the instance property key
    
    tag - the tag that identifies the PublicObject
    
    Throws:
    
    IfsException - if the operation fails
  - setSystemObjectInstanceProperty
```
public void setSystemObjectInstanceProperty(String key,
                                            String tag)
                                     throws IfsException
```
    Deprecated. 9.0.4.6: use setInstanceProperty
    
    Set an instance property that is a SystemObject, identified by tag.
    
    Parameters:
    
    key - the instance property key
    
    tag - the tag that identifies the SystemObject
    
    Throws:
    
    IfsException - if the operation fails
  - createNamedPropertyBundle
```
public void createNamedPropertyBundle(AttributeValueTable avt)
                               throws IfsException
```
    Creates a Named PropertyBundle.
    A named PropertyBundle is a PropertyBundle that is also the value of a ValueDefault. The name chosen for the named PropertyBundle will also be the name of the ValueDefault, which must be unique across the entire instance. This is an older way of accomplishing this unique naming and identification; in later years, the "Domain PropertyBundle" was used to hold the items, using that PropertyBundle's namespace to ensure easy lookup. The keys supported by this operation:
    - TAG: the tag that identifies the newly created PropertyBundle
    - NAME: the PropertyBundle (and encapsulating ValueDefault) name
    - DESCRIPTION: the description
    - ACL: the ACL to use for the PropertyBundle
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyNamedPropertyBundle
```
public void identifyNamedPropertyBundle(String tag,
                                        String name)
                                 throws IfsException
```
    Identify a Named PropertyBundle.
    
    Parameters:
    
    tag - the tag to use
    
    name - the Named PropertyBundle name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showNamedPropertyBundle
```
public void showNamedPropertyBundle(String name)
                             throws IfsException
```
    Show details about a Named PropertyBundle.
    
    Parameters:
    
    name - the Named PropertyBundle name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeNamedPropertyBundle
```
public void freeNamedPropertyBundle(String name)
                             throws IfsException
```
    Frees a Named PropertyBundle.
    
    Parameters:
    
    name - the Named PropertyBundle name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeNamedPropertyBundle
```
public void freeNamedPropertyBundle(AttributeValueTable avt)
                             throws IfsException
```
    Frees a Named PropertyBundle.
    The keys supported by this operation:
    - NAME: the Named PropertyBundle name
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createPropertyBundle
```
public void createPropertyBundle(AttributeValueTable avt)
                          throws IfsException
```
    Creates a regular PropertyBundle. The keys supported by this operation:
    - TAG: the tag that identifies the newly created PropertyBundle
    - NAME: the PropertyBundle name
    - DESCRIPTION: the description
    - ACL: the ACL to use for the PropertyBundle
    - DEFTAG: a PropertyBundleDefinition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setProperty
```
public void setProperty(AttributeValueTable avt)
                 throws IfsException
```
    Sets a Property on an identified PropertyBundle.
    The keys supported by this operation:
    - TAG: the tag that identifies the PropertyBundle
    - PROPERTYNAME (or KEY or NAME): the Property name
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - removeProperties
```
public void removeProperties(AttributeValueTable avt)
                      throws IfsException
```
    Removes a Property or a set of Properties from a PropertyBundle.
    The keys supported by this operation:
    - TAG: the tag that identifies the PropertyBundle
    - KEY: the Property key
    - KEYARRAY: the array of Property keys to remove
    - REMOVEALL: whether to remove all of the existing properties (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyObjectProperty
```
public void identifyObjectProperty(AttributeValueTable avt)
                            throws IfsException
```
    Identifies an object Property on an identified PropertyBundle.
    The keys supported by this operation:
    - TAG: the tag that will identify the object property
    - BUNDLETAG: the PropertyBundle
    - PROPERTYNAME (or KEY): the Property name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showPropertyBundle
```
public void showPropertyBundle(String pbTag)
                        throws IfsException
```
    Shows the properties of a PropertyBundle.
    
    Parameters:
    
    pbTag - the tag that identifies the PropertyBundle
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showProperty
```
public void showProperty(String pbTag,
                         String key)
                  throws IfsException
```
    Shows a property of a PropertyBundle.
    
    Parameters:
    
    pbTag - the tag that identifies the PropertyBundle
    
    key - the property key
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setObjectProperty
```
public void setObjectProperty(AttributeValueTable avt)
                       throws IfsException
```
    Sets a Property on a specified LibraryObject.
    The keys supported by this operation:
    - TAG: the tag that identifies the object which will get a new (or updated) property
    - PROPERTYNAME (or KEY or NAME): the Property name
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - setClassProperty
```
public void setClassProperty(AttributeValueTable avt)
                      throws IfsException
```
    Sets a class-level Property on the specified ClassObject PropertyBundle.
    The keys supported by this operation:
    - CLASSNAME: the name of the ClassObject whose PropertyBundle will be updated
    - PROPERTYNAME (or KEY or NAME): the Property name
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - identifyPropertyBundle
```
public void identifyPropertyBundle(AttributeValueTable avt)
                            throws IfsException
```
    Identify a PropertyBundle as the bundle used by a previously identified LibraryObject.
    The keys supported by this operation:
    - BUNDLETAG (or TAG): the Tag that will identify the PropertyBundle
    - OBJECTTAG: the Tag that identifies the LibraryObject whose ProeprtyBundle will be referenced
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - createSimplePropertyTable
```
public void createSimplePropertyTable(AttributeValueTable avt)
                               throws IfsException
```
    Creates a SimplePropertyTable. The keys supported by this operation:
    - TAG: the tag that identifies the newly created SimplePropertyTable
    - NAME: the SimplePropertyTable name
    - PROPERTIES: the properties
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showSimplePropertyTable
```
public void showSimplePropertyTable(AttributeValueTable avt)
                             throws IfsException
```
    Shows a SimplePropertyTable. The keys supported by this operation:
    - TAG: the tag that identifies the SimplePropertyTable
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createSimplePropertyTableList
```
public void createSimplePropertyTableList(AttributeValueTable avt)
                                   throws IfsException
```
    Creates a SimplePropertyTableList. The keys supported by this operation:
    - TAG: the tag that identifies the newly created SimplePropertyTable
    - NAME: the SimplePropertyTable name
    - OBJECTPROPERTYTABLE: the properties
    - PROPERTYTABLES: the properties
    - DETAILLISTS: the properties
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showSimplePropertyTableList
```
public void showSimplePropertyTableList(AttributeValueTable avt)
                                 throws IfsException
```
    Shows a SimplePropertyTableList. The keys supported by this operation:
    - TAG: the tag that identifies the SimplePropertyTableList
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showSessionState
```
public void showSessionState(String stateKey)
                      throws IfsException
```
    Show the session state value in the current session for the specified session state key.
    
    Parameters:
    
    stateKey - the session state key
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setStringSessionState
```
public void setStringSessionState(String stateKey,
                                  String value)
                           throws IfsException
```
    Set String session state for the specified session state key.
    
    Parameters:
    
    stateKey - the session state key
    
    value - the session state key value
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setLongSessionState
```
public void setLongSessionState(String stateKey,
                                String value)
                         throws IfsException
```
    Set Long session state for the specified session state key.
    
    Parameters:
    
    stateKey - the session state key
    
    value - the session state key value (numeric)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeSessionState
```
public void removeSessionState(String stateKey)
                        throws IfsException
```
    Remove session state for the specified session state key.
    
    Parameters:
    
    stateKey - the session state key
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createApplicationToken
```
public void createApplicationToken(AttributeValueTable avt)
                            throws IfsException
```
    Creates a ApplicationToken.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - DEFTAG: the definition tag to use as the base definition
    - TOKENVALUE: the token value (uniquely identifies token)
    - TOKENINFO: the token info
    - TIMEOUTPERIOD: the timeout period for the token
    - SKIPIFEXISTS: whether to skip creation if an object with a matching token value already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createApplicationToken
```
public void createApplicationToken(String tokenTag,
                                   String tokenDefTag)
                            throws IfsException
```
    Create a ApplicationToken.
    
    Parameters:
    
    tokenTag - the ApplicationToken tag
    
    tokenDefTag - the ApplicationToken definition tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyApplicationToken
```
public void identifyApplicationToken(String tokenTag,
                                     String tokenValue)
                              throws IfsException
```
    Lookup and identify a ApplicationToken by the object's token value.
    
    Parameters:
    
    tokenTag - the tag to be used for the ApplicationToken
    
    tokenValue - the ApplicationToken token value
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showApplicationToken
```
public void showApplicationToken(String tkTag)
                          throws IfsException
```
    Show details about a ApplicationToken.
    
    Parameters:
    
    tkTag - the ApplicationToken tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showApplicationTokens
```
public void showApplicationTokens()
                           throws IfsException
```
    Show details about all ApplicationTokens in an Instance.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createRetentionPolicy
```
public void createRetentionPolicy(String rpTag,
                                  String defTag)
                           throws IfsException
```
    Create a RetentionPolicy.
    
    Parameters:
    
    rpTag - the RetentionPolicy tag
    
    defTag - the tag identifying the Definition describing the RetentionPolicy to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyRetentionPolicy
```
public void identifyRetentionPolicy(String rpTag,
                                    String rpName)
                             throws IfsException
```
    Identify a RetentionPolicy by its unique name.
    
    Parameters:
    
    rpTag - the RetentionPolicy tag
    
    rpName - the RetentionPolicy name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showRetentionPolicy
```
public void showRetentionPolicy(String rpTag)
                         throws IfsException
```
    Show details about a RetentionPolicy.
    
    Parameters:
    
    rpTag - the RetentionPolicy tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllRetentionPolicies
```
public void showAllRetentionPolicies()
                              throws IfsException
```
    Shows all of the RetentionPolicy instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllExternalRetentionPolicies
```
public void showAllExternalRetentionPolicies()
                                      throws IfsException
```
    Shows all of the ExternalRetentionPolicy instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecyclePolicy
```
public void createLifecyclePolicy(AttributeValueTable avt)
                           throws IfsException
```
    Creates a LifecyclePolicyActionSpecification.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the object name
    - DESCRIPTION: the object description
    - LIFECYCLEPOLICYACTIONCLASSNAME: the fully qualified action class name
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecyclePolicy
```
public void createLifecyclePolicy(String lpTag,
                                  String defTag)
                           throws IfsException
```
    Create a LifecyclePolicy.
    
    Parameters:
    
    lpTag - the LifecyclePolicy tag
    
    defTag - the tag identifying the Definition describing the LifecyclePolicy to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyLifecyclePolicy
```
public void identifyLifecyclePolicy(String lpTag,
                                    String lpName)
                             throws IfsException
```
    Identify a LifecyclePolicy by its unique name.
    
    Parameters:
    
    lpTag - the LifecyclePolicy tag
    
    lpName - the LifecyclePolicy name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showLifecyclePolicy
```
public void showLifecyclePolicy(String lpTag)
                         throws IfsException
```
    Show details about a LifecyclePolicy.
    
    Parameters:
    
    lpTag - the LifecyclePolicy tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showLifecyclePolicyEntry
```
public void showLifecyclePolicyEntry(String lpeTag)
                              throws IfsException
```
    Show details about a LifecyclePolicyEntry.
    
    Parameters:
    
    lpeTag - the LifecyclePolicyEntry tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllLifecyclePolicies
```
public void showAllLifecyclePolicies()
                              throws IfsException
```
    Shows all of the LifecyclePolicy instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecyclePolicyEntryDefinition
```
public void createLifecyclePolicyEntryDefinition(String defTag,
                                                 String lpeName,
                                                 String lpeDesc,
                                                 String actionTag,
                                                 String timePeriod,
                                                 String execPeriod,
                                                 String execBaseTime)
                                          throws IfsException
```
    Create and register a LifecyclePolicyEntry definition.
    
    Parameters:
    
    defTag - the LifecyclePolicyEntry definition tag
    
    lpeName - the LifecyclePolicyEntry instance name
    
    lpeDesc - the LifecyclePolicyEntry instance description
    
    actionTag - the tag for the LifecyclePolicyActionSpecification
    
    timePeriod - the time period for the lifecycle action (e.g. "60D")
    
    execPeriod - the frequency of execution for the action (e.g. "8H")
    
    execBaseTime - the base time-of-day for execution (e.g. "22:30:00")
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addLifecyclePolicyEntryDefinition
```
public void addLifecyclePolicyEntryDefinition(String lpDefTag,
                                              String lpeDefTag)
                                       throws IfsException
```
    Add a LifecyclePolicyEntry definition to a LifecyclePolicy definition.
    
    Parameters:
    
    lpDefTag - the LifecyclePolicy definition tag
    
    lpeDefTag - the LifecyclePolicyEntry definition tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addLifecyclePolicyEntryDefinition
```
public void addLifecyclePolicyEntryDefinition(String defTag,
                                              String lpeName,
                                              String lpeDesc,
                                              String actionTag,
                                              String timePeriod,
                                              String execPeriod,
                                              String execBaseTime)
                                       throws IfsException
```
    Add a LifecyclePolicyEntry definition to a LifecyclePolicy definition.
    
    Parameters:
    
    defTag - the LifecyclePolicy definition tag
    
    lpeName - the LifecyclePolicyEntry instance name
    
    lpeDesc - the LifecyclePolicyEntry instance description
    
    actionTag - the tag for the LifecyclePolicyActionSpecification
    
    timePeriod - the time period for the lifecycle action (e.g. "60D")
    
    execPeriod - the frequency of execution for the action (e.g. "8H")
    
    execBaseTime - the base time-of-day for execution (e.g. "22:30:00")
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyLifecyclePolicyEntry
```
public void identifyLifecyclePolicyEntry(String lpeTag,
                                         String lpTag,
                                         String lpeSeq)
                                  throws IfsException
```
    Identify a LifecyclePolicyEntry by its parent LifecyclePolicy and its sequence within that LifecyclePolicy.
    
    Parameters:
    
    lpeTag - the LifecyclePolicyEntry tag to use for the newly identified object
    
    lpTag - the LifecyclePolicy tag
    
    lpeSeq - the LifecyclePolicyEntry sequence value
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecycleDateRuleSpecification
```
public void createLifecycleDateRuleSpecification(AttributeValueTable avt)
                                          throws IfsException
```
    Creates a LifecycleDateRuleSpecification.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the object name
    - DESCRIPTION: the object description
    - LIFECYCLEDATERULECLASSNAME: the LifeCycleDateRule class
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecycleDateRuleSpecification
```
public void createLifecycleDateRuleSpecification(String specTag,
                                                 String defTag)
                                          throws IfsException
```
    Create a LifecycleDateRuleSpecification.
    
    Parameters:
    
    specTag - the LifecycleDateRuleSpecification tag
    
    defTag - the tag identifying the Definition describing the LifecycleDateRuleSpecification to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyLifecycleDateRuleSpecification
```
public void identifyLifecycleDateRuleSpecification(String specTag,
                                                   String specName)
                                            throws IfsException
```
    Identify a LifecycleDateRuleSpecification by its unique name.
    
    Parameters:
    
    specTag - the LifecycleDateRuleSpecification tag
    
    specName - the LifecycleDateRuleSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showLifecycleDateRuleSpecification
```
public void showLifecycleDateRuleSpecification(String specTag)
                                        throws IfsException
```
    Show details about a LifecycleDateRuleSpecification.
    
    Parameters:
    
    specTag - the LifecycleDateRuleSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllLifecycleDateRuleSpecifications
```
public void showAllLifecycleDateRuleSpecifications()
                                            throws IfsException
```
    Shows all of the LifecycleDateRuleSpecifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecyclePolicyActionSpecification
```
public void createLifecyclePolicyActionSpecification(AttributeValueTable avt)
                                              throws IfsException
```
    Creates a LifecyclePolicyActionSpecification.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the object name
    - DESCRIPTION: the object description
    - LIFECYCLEPOLICYACTIONCLASSNAME: the fully qualified action class name
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLifecyclePolicyActionSpecification
```
public void createLifecyclePolicyActionSpecification(String specTag,
                                                     String defTag)
                                              throws IfsException
```
    Create a LifecyclePolicyActionSpecification.
    
    Parameters:
    
    specTag - the LifecyclePolicyActionSpecification tag
    
    defTag - the tag identifying the Definition describing the LifecyclePolicyActionSpecification to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyLifecyclePolicyActionSpecification
```
public void identifyLifecyclePolicyActionSpecification(String specTag,
                                                       String specName)
                                                throws IfsException
```
    Identify a LifecyclePolicyActionSpecification by its unique name.
    
    Parameters:
    
    specTag - the LifecyclePolicyActionSpecification tag
    
    specName - the LifecyclePolicyActionSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showLifecyclePolicyActionSpecification
```
public void showLifecyclePolicyActionSpecification(String specTag)
                                            throws IfsException
```
    Show details about a LifecyclePolicyActionSpecification.
    
    Parameters:
    
    specTag - the LifecyclePolicyActionSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllLifecyclePolicyActionSpecifications
```
public void showAllLifecyclePolicyActionSpecifications()
                                                throws IfsException
```
    Shows all of the LifecyclePolicyActionSpecifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDocumentsWithLifecyclePolicy
```
public void showDocumentsWithLifecyclePolicy(String lpTag,
                                             String batchValue)
                                      throws IfsException
```
    Show documents that are referencing the specified LifecyclePolicy.
    sort by name, ID
    
    Parameters:
    
    lpTag - the LifecyclePolicy tag
    
    batchValue - the maximum number of items to show
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - assignLifecyclePolicyByCategory
```
public void assignLifecyclePolicyByCategory(String lpTag,
                                            String className)
                                     throws IfsException
```
    Assign the specified LifecyclePolicy to all documents not yet assigned to a LifecyclePolicy and that have at least one instance of the category specified.
    Performs a best-effort assignment of LifecyclePolicy for each document that qualifies. Shows all failures in the log.
    
    Parameters:
    
    lpTag - the LifecyclePolicy tag
    
    className - the Category class name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deleteAllCategories
```
public void deleteAllCategories(String className)
                         throws IfsException
```
    Deletes all Category instances for the specified Category.
    
    Parameters:
    
    className - the Category class name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyMessageList
```
public void identifyMessageList(AttributeValueTable avt)
                         throws IfsException
```
    Identify a MessageList for a PublicObject that has an ActivityRecord.
    The keys supported by this operation:
    - TAG: the tag that will identify MessageList
    - PUBLICOBJECT: the tag that identifies the target PublicObject to check
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - identifyMessageEntry
```
public void identifyMessageEntry(AttributeValueTable avt)
                          throws IfsException
```
    Identify a MessageEntry for a PublicObject that has an ActivityRecord.
    The keys supported by this operation:
    - TAG: the tag that will identify MessageEntry
    - PUBLICOBJECT: the tag that identifies the target PublicObject to check
    - MESSAGEENTRYNAME (or NAME): the name of the MessageEntry
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - showMessageList
```
public void showMessageList(AttributeValueTable avt)
                     throws IfsException
```
    Show MessageList information.
    The keys supported by this operation:
    - MESSAGELIST (or TAG): the tag that identifies a MessageList to show
    - VERBOSE: whether the output should be verbose.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - showMessageEntry
```
public void showMessageEntry(AttributeValueTable avt)
                      throws IfsException
```
    Show MessageEntry information.
    The keys supported by this operation:
    - MESSAGEENTRY (or TAG): the tag that identifies a MessageEntry to show
    - VERBOSE: whether the output should be verbose.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - createMedia
```
public void createMedia(AttributeValueTable avt)
                 throws IfsException
```
    Creates a Media.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created Media
    - DEFTAG: the definition tag to use as the base definition
    - TYPE: the Media type, one of {Blob, Bfile, Custom}; must specify even if DEFTAG used
    - NAME: the Media name; must specify even if DEFTAG used
    - TABLENAME: the table name
    - COLUMNNAME: the column name
    - READONLY: whether the Media is readonly (boolean)
    - STORAGETYPE: for TYPE=Blob, one of DEFAULT, SECUREFILE, or BASICFILE
    - TABLESPACE: for TYPE=Blob, the tablespace to use for storage
    - STORAGECLAUSE: for TYPE=Blob, the SQL clause to append to: " LOB (columnname) [STORE AS storagetype] "
    - BASEBFILEPATH: for TYPE=Bfile, the absolute path to the base directory where the content is stored
    - CUSTOMDRIVERNAME: for TYPE=Custom, the name of the CustomMediaDriverSpecification that defines driver
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    - SKIPIFUNSUPPORTED: whether to skip creation if the type specified is not supported (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createMedia
```
public void createMedia(String mediaTag,
                        String defTag)
                 throws IfsException
```
    Creates a Media.
    
    Parameters:
    
    mediaTag - the Media tag
    
    defTag - the tag identifying the Definition describing the Media to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyMedia
```
public void identifyMedia(String mediaTag,
                          String mediaName)
                   throws IfsException
```
    Identifies a Media by its unique name.
    
    Parameters:
    
    mediaTag - the Media tag
    
    mediaName - the Media name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showMedia
```
public void showMedia(String mediaTag)
               throws IfsException
```
    Shows details about a Media.
    
    Parameters:
    
    mediaTag - the Media tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllMedias
```
public void showAllMedias()
                   throws IfsException
```
    Shows all of the Media instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDefaultMedia
```
public void showDefaultMedia()
                      throws IfsException
```
    Shows the default Media.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDefaultMedia
```
public void setDefaultMedia(String mediaTag)
                     throws IfsException
```
    Sets the default Media.
    
    Parameters:
    
    mediaTag - the Media tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - syncContentIndex
```
public void syncContentIndex()
                      throws IfsException
```
    Trigger a sync of the content index.
    
    Throws:
    
    IfsException - if the operation fails
  - extractContentForIndexing
```
public void extractContentForIndexing()
                               throws IfsException
```
    Extract content for indirect text indexing.
    
    Throws:
    
    IfsException - if the operation fails
  - syncIndex
```
public void syncIndex(AttributeValueTable avt)
               throws IfsException
```
    Sync the specified Oracle Text index by name.
    This operation only works in Oracle installations.
    The keys supported by this operation:
    - INDEXNAME: the Oracle Text index name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - initializeManualTextIndexingRetainedEvents
```
public void initializeManualTextIndexingRetainedEvents(AttributeValueTable avt)
                                                throws IfsException
```
    Initializes handling of ManualTextIndexingRetainedEvents.
    Creates the database objects used by the ManualTextIndexingRetainedEvent class. The keys supported by this operation:
    - DROPEXISTING: whether to attempt to drop the existing tables first
    - VERBOSE: whether the output should be verbose.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - processManualTextIndexingRetainedEvents
```
public void processManualTextIndexingRetainedEvents(AttributeValueTable avt)
                                             throws IfsException
```
    Processes all of the currently queued ManualTextIndexingRetainedEvents.
    This simulates the task performed by the ManualTextIndexingAgent. The keys supported by this operation:
    - BATCHSIZE: The batch size to use.
    - PURGEONLY: whether to simply delete all of the queued events without processing (for test cleanup).
    - VERBOSE: whether the output should be verbose.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - showMediaLookupByFormatMappings
```
public void showMediaLookupByFormatMappings()
                                     throws IfsException
```
    Shows the MediaLookUpByFormat property bundle, which holds the mappings of Format to Media.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setMediaLookupByFormat
```
public void setMediaLookupByFormat(String formatName,
                                   String mediaTag)
                            throws IfsException
```
    Adds a mapping to the MediaLookUpByFormat property bundle, which holds the mappings of Format to Media.
    
    Parameters:
    
    formatName - the Format name
    
    mediaTag - the Media tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - replaceMediaLookupsByFormat
```
public void replaceMediaLookupsByFormat(String currMediaTag,
                                        String newMediaTag)
                                 throws IfsException
```
    Replaces the Format/Media mappings so that a new Media instance is mapped.
    
    Parameters:
    
    currMediaTag - the current Media (to be replaced)
    
    newMediaTag - the new Media that replaces to current Media
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createCustomMediaDriverSpecification
```
public void createCustomMediaDriverSpecification(AttributeValueTable avt)
                                          throws IfsException
```
    Creates a new CustomMediaDriverSpecification entirely, using embeeded definitions.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the name
    - DESCRIPTION: the description
    - CUSTOMMEDIADRIVERCLASSNAME: the driver's fully qualified class name
    - ACTIVE: whether the newly created object should be Active
    - PROPERTIES: Properties to be added to the new object's PropertyBundle
    - FREEEXISTINGOBJECT: whether to free an existing object with the same name
    - SKIPIFEXISTS: whether to skip the creation request if an object exists with the same name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createCustomMediaDriverSpecification
```
public void createCustomMediaDriverSpecification(String cmdsTag,
                                                 String defTag)
                                          throws IfsException
```
    Creates a CustomMediaDriverSpecification.
    
    Parameters:
    
    cmdsTag - the CustomMediaDriverSpecification tag
    
    defTag - the tag identifying the Definition describing the CustomMediaDriverSpecification to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyCustomMediaDriverSpecification
```
public void identifyCustomMediaDriverSpecification(String cmdsTag,
                                                   String cmdsName)
                                            throws IfsException
```
    Identifies a CustomMediaDriverSpecification by its unique name.
    
    Parameters:
    
    cmdsTag - the CustomMediaDriverSpecification tag
    
    cmdsName - the CustomMediaDriverSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showCustomMediaDriverSpecification
```
public void showCustomMediaDriverSpecification(String cmdsTag)
                                        throws IfsException
```
    Shows details about a CustomMediaDriverSpecification.
    
    Parameters:
    
    cmdsTag - the CustomMediaDriverSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllCustomMediaDriverSpecifications
```
public void showAllCustomMediaDriverSpecifications()
                                            throws IfsException
```
    Shows all of the CustomMediaDriverSpecification instances.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createStorageGroup
```
public void createStorageGroup(AttributeValueTable avt)
                        throws IfsException
```
    Creates a StorageGroup.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created StorageGroup
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the StorageGroup name; must specify even if DEFTAG used
    - PARTITIONVALUE: the partition value
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createStorageGroup
```
public void createStorageGroup(String sgTag,
                               String defTag)
                        throws IfsException
```
    Creates a StorageGroup.
    
    Parameters:
    
    sgTag - the StorageGroup tag
    
    defTag - the tag identifying the Definition describing the StorageGroup to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyStorageGroup
```
public void identifyStorageGroup(String sgTag,
                                 String sgName)
                          throws IfsException
```
    Identifies a StorageGroup by its unique name.
    
    Parameters:
    
    sgTag - the StorageGroup tag
    
    sgName - the StorageGroup name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showStorageGroup
```
public void showStorageGroup(String sgTag)
                      throws IfsException
```
    Shows details about a StorageGroup.
    
    Parameters:
    
    sgTag - the StorageGroup tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllStorageGroups
```
public void showAllStorageGroups()
                          throws IfsException
```
    Shows all of the StorageGroups.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDefaultStorageGroup
```
public void showDefaultStorageGroup()
                             throws IfsException
```
    Shows the default StorageGroup.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDefaultStorageGroup
```
public void setDefaultStorageGroup(String sgTag)
                            throws IfsException
```
    Sets the default StorageGroup.
    
    Parameters:
    
    sgTag - the StorageGroup tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createSystemLockObject
```
public void createSystemLockObject(AttributeValueTable avt)
                            throws IfsException
```
    Creates a SystemLockObject. The keys supported by this operation:
    - TAG: the tag that identifies the newly created SystemLockObject
    - NAME: the SystemLockObject name
    - LOCKSTATE: the lock state (integer)
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifySystemLockObject
```
public void identifySystemLockObject(String sloTag,
                                     String sloName)
                              throws IfsException
```
    Identify a SystemLockObject by name.
    
    Parameters:
    
    sloTag - the SystemLockObject tag
    
    sloName - the SystemLockObject name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createQueue
```
public void createQueue(AttributeValueTable avt)
                 throws IfsException
```
    Creates a Queue. The keys supported by this operation:
    - TAG: the tag that identifies the newly created Queue
    - NAME: the Queue name
    - DESCRIPTION: the Queue description
    - ACL: the ACL to use (defaults to Published)
    - PAYLOADTYPE: the Payload type
    - MESSAGEPROCESSORCLASS: the Message Processor class
    - TYPEMAPBUNDLE: the PropertyBundle to use as the type map
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyQueue
```
public void identifyQueue(String quTag,
                          String quName)
                   throws IfsException
```
    Identify a Queue by name.
    
    Parameters:
    
    quTag - the Queue tag
    
    quName - the Queue name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyQueueTypeMapBundle
```
public void identifyQueueTypeMapBundle(String pbTag,
                                       String quName)
                                throws IfsException
```
    Identify the PropertyBundle used by a Queue to map message types.
    
    Parameters:
    
    pbTag - the PropertyBundle tag
    
    quName - the Queue name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAutoFolderingActionSpecification
```
public void createAutoFolderingActionSpecification(AttributeValueTable avt)
                                            throws IfsException
```
    Creates a new AutoFolderingActionSpecification entirely, using embeeded definitions.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the name
    - DESCRIPTION: the description
    - AUTOFOLDERINGACTIONCLASSNAME: the driver's fully qualified class name
    - INTERNAL: whether the newly created object should be Active
    - FREEEXISTINGOBJECT: whether to free an existing object with the same name
    - SKIPIFEXISTS: whether to skip the creation request if an object exists with the same name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createAutoFolderingActionSpecification
```
public void createAutoFolderingActionSpecification(String specTag,
                                                   String defTag)
                                            throws IfsException
```
    Create a AutoFolderingActionSpecification.
    
    Parameters:
    
    specTag - the AutoFolderingActionSpecification tag
    
    defTag - the tag identifying the Definition describing the AutoFolderingActionSpecification to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAutoFolderingActionSpecification
```
public void identifyAutoFolderingActionSpecification(String specTag,
                                                     String specName)
                                              throws IfsException
```
    Identify a AutoFolderingActionSpecification by its unique name.
    
    Parameters:
    
    specTag - the AutoFolderingActionSpecification tag
    
    specName - the AutoFolderingActionSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAutoFolderingActionSpecification
```
public void showAutoFolderingActionSpecification(String specTag)
                                          throws IfsException
```
    Show details about a AutoFolderingActionSpecification.
    
    Parameters:
    
    specTag - the AutoFolderingActionSpecification tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllAutoFolderingActionSpecifications
```
public void showAllAutoFolderingActionSpecifications()
                                              throws IfsException
```
    Shows all of the AutoFolderingActionSpecifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createOperationActionSpecification
```
public void createOperationActionSpecification(AttributeValueTable avt)
                                        throws IfsException
```
    Creates a new OperationActionSpecification entirely, using embeeded definitions.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created object
    - NAME: the name
    - DESCRIPTION: the description
    - AUTOFOLDERINGACTIONCLASSNAME: the driver's fully qualified class name
    - INTERNAL: whether the newly created object should be Active
    - FREEEXISTINGOBJECT: whether to free an existing object with the same name
    - SKIPIFEXISTS: whether to skip the creation request if an object exists with the same name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createOperationActionSpecification
```
public void createOperationActionSpecification(String specTag,
                                               String defTag)
                                        throws IfsException
```
    Create a OperationActionSpecification.
    
    Parameters:
    
    specTag - the OperationActionSpecification tag
    
    defTag - the tag identifying the Definition describing the OperationActionSpecification to create
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyOperationActionSpecification
```
public void identifyOperationActionSpecification(String specTag,
                                                 String specName)
                                          throws IfsException
```
    Identify a OperationActionSpecification by its unique name.
    
    Parameters:
    
    specTag - the OperationActionSpecification tag
    
    specName - the OperationActionSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - activateOperationActionSpecification
```
public void activateOperationActionSpecification(String tagOrName)
                                          throws IfsException
```
    Activate a OperationActionSpecification.
    
    Parameters:
    
    tagOrName - the OperationActionSpecification tag or name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deactivateOperationActionSpecification
```
public void deactivateOperationActionSpecification(String tagOrName)
                                            throws IfsException
```
    Deactivate a OperationActionSpecification.
    
    Parameters:
    
    tagOrName - the OperationActionSpecification tag or name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showOperationActionSpecification
```
public void showOperationActionSpecification(String tagOrName)
                                      throws IfsException
```
    Show details about a OperationActionSpecification.
    
    Parameters:
    
    tagOrName - the OperationActionSpecification tag or name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllOperationActionSpecifications
```
public void showAllOperationActionSpecifications()
                                          throws IfsException
```
    Shows all of the OperationActionSpecifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showGlobalOperationActionSpecifications
```
public void showGlobalOperationActionSpecifications()
                                             throws IfsException
```
    Shows the list of global OperationActionSpecifications defined as a domain property.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setGlobalOperationActionSpecifications
```
public void setGlobalOperationActionSpecifications(String oasArrayToken)
                                            throws IfsException
```
    Sets the list of global OperationActionSpecifications defined as a domain property.
    
    Parameters:
    
    oasArrayToken - the array of OperationActionSpecification names
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addGlobalOperationActionSpecification
```
public void addGlobalOperationActionSpecification(String specName)
                                           throws IfsException
```
    Adds an OperationActionSpecification to the list of global OperationActionSpecifications, defined in a domain property.
    
    Parameters:
    
    specName - the OperationActionSpecification name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - saveGlobalOperationActionSpecification
```
public void saveGlobalOperationActionSpecification()
                                            throws IfsException
```
    Saves a copy of the list of global OperationActionSpecifications, defined in a domain property.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - restoreGlobalOperationActionSpecification
```
public void restoreGlobalOperationActionSpecification()
                                               throws IfsException
```
    Restores the list of global OperationActionSpecifications from a previously saved copy.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - deactivateUnknownOperationActionSpecifications
```
public void deactivateUnknownOperationActionSpecifications()
                                                    throws IfsException
```
    Deactivate all active OperationActionSpecification instances whose associated OperationAction class is not constructable.
    Used during upgrade and other schema management operations where custom OperationActions may not be present in the class path used.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - reactivateUnknownOperationActionSpecifications
```
public void reactivateUnknownOperationActionSpecifications()
                                                    throws IfsException
```
    Re-activate all OperationActionSpecification instances that were previously de-activated via operation deactivateUnknownOperationActionSpecification.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDefinitionObject
```
public void createDefinitionObject(String defobjTag,
                                   String defTag)
                            throws IfsException
```
    Create a DefinitionObject.
    
    Parameters:
    
    defobjTag - the DefinitionObject tag
    
    defTag - the tag identifying the Definition to save
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateDefinitionObject
```
public void updateDefinitionObject(String defobjTag,
                                   String defTag)
                            throws IfsException
```
    Update a DefinitionObject.
    
    Parameters:
    
    defobjTag - the DefinitionObject tag, identifying an existing DefinitionObject
    
    defTag - the tag identifying the Definition to save
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDefinitionObject
```
public void showDefinitionObject(String defobjTag)
                          throws IfsException
```
    Show details about a DefinitionObject.
    
    Parameters:
    
    defobjTag - the DefinitionObject tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDefinitionFromObject
```
public void createDefinitionFromObject(String defTag,
                                       String objTag)
                                throws IfsException
```
    Create a LibraryObjectDefinition from a LibraryObject.
    
    Parameters:
    
    defTag - the tag identifying the converted Definition
    
    objTag - the LibraryObject tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDefinitionFromDefinitionObject
```
public void createDefinitionFromDefinitionObject(String defTag,
                                                 String defobjTag)
                                          throws IfsException
```
    Create a LibraryObjectDefinition from a DefinitionObject.
    
    Parameters:
    
    defTag - the tag identifying the converted Definition
    
    defobjTag - the DefinitionObject tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFormat
```
public void createFormat(AttributeValueTable avt)
                  throws IfsException
```
    Creates a Format.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created Format
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the Format name
    - MIMETYPE: the MIME type
    - EXTENSION: the file extension
    - BINARY: whether the Format is a binary format (boolean)
    - INDEXED: whether the Format is text indexed (boolean)
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyFormat
```
public void identifyFormat(String formatTag,
                           String formatName)
                    throws IfsException
```
    Identifies a Format by its unique name.
    
    Parameters:
    
    formatTag - the Format tag
    
    formatName - the Format name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showFormat
```
public void showFormat(String formatName)
                throws IfsException
```
    Show details about a Format.
    
    Parameters:
    
    formatName - the Format name or tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllFormats
```
public void showAllFormats()
                    throws IfsException
```
    Shows all of the Formats.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeFormat
```
public void freeFormat(AttributeValueTable avt)
                throws IfsException
```
    Frees a Format.
    The keys supported by this operation:
    - NAME: the Format name
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createPermissionBundle
```
public void createPermissionBundle(AttributeValueTable avt)
                            throws IfsException
```
    Creates a PermissionBundle.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created PermissionBundle
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the PermissionBundle name
    - DESCRIPTION: the PermissionBundle description
    - ACCESSLEVEL: the set of permissions; e.g. "{Discover, Delete}"
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyPermissionBundle
```
public void identifyPermissionBundle(String tag,
                                     String name)
                              throws IfsException
```
    Identify a PermissionBundle.
    
    Parameters:
    
    tag - the tag to use
    
    name - the PermissionBundle name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showPermissionBundle
```
public void showPermissionBundle(String name)
                          throws IfsException
```
    Show details about a PermissionBundle.
    
    Parameters:
    
    name - the PermissionBundle name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllPermissionBundles
```
public void showAllPermissionBundles()
                              throws IfsException
```
    Shows all of the PermissionBundles.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freePermissionBundle
```
public void freePermissionBundle(AttributeValueTable avt)
                          throws IfsException
```
    Frees a PermissionBundle.
    The keys supported by this operation:
    - NAME: the PermissionBundle name
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createExtendedPermission
```
public void createExtendedPermission(AttributeValueTable avt)
                              throws IfsException
```
    Creates an ExtendedPermission.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ExtendedPermission
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the ExtendedPermission name
    - DESCRIPTION: the ExtendedPermission description
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyExtendedPermission
```
public void identifyExtendedPermission(String tag,
                                       String name)
                                throws IfsException
```
    Identify a ExtendedPermission.
    
    Parameters:
    
    tag - the tag to use
    
    name - the ExtendedPermission name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showExtendedPermission
```
public void showExtendedPermission(String name)
                            throws IfsException
```
    Show details about a ExtendedPermission.
    
    Parameters:
    
    name - the ExtendedPermission name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllExtendedPermissions
```
public void showAllExtendedPermissions()
                                throws IfsException
```
    Shows all of the ExtendedPermissions.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeExtendedPermission
```
public void freeExtendedPermission(AttributeValueTable avt)
                            throws IfsException
```
    Frees a ExtendedPermission.
    The keys supported by this operation:
    - NAME: the ExtendedPermission name
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createPolicy
```
public void createPolicy(AttributeValueTable avt)
                  throws IfsException
```
    Creates a Policy.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created Policy
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the Policy name
    - POLICYACTION: the Policy action
    - EXECUTIONMODE: the execution mode for the Policy; one of: PREEXISTING, USER, DISCOVERYADMINISTRATION, ADMINISTRATION, SYSTEMADMINISTRATION, INSTALLATION
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyPolicy
```
public void identifyPolicy(String tag,
                           String name)
                    throws IfsException
```
    Identify a Policy.
    
    Parameters:
    
    tag - the tag to use
    
    name - the Policy name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showPolicy
```
public void showPolicy(String name)
                throws IfsException
```
    Show details about a Policy.
    
    Parameters:
    
    name - the Policy name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllPolicies
```
public void showAllPolicies()
                     throws IfsException
```
    Shows all of the Policies.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freePolicy
```
public void freePolicy(AttributeValueTable avt)
                throws IfsException
```
    Frees a Policy.
    The keys supported by this operation:
    - NAME: the Policy name
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createPolicyList
```
public void createPolicyList(AttributeValueTable avt)
                      throws IfsException
```
    Creates a PolicyList.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created Policy
    - NAME: the PolicyList name
    - POLICYLISTELEMENTS: the PolicyListElement definitions
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setClassPolicyList
```
public void setClassPolicyList(AttributeValueTable avt)
                        throws IfsException
```
    Sets a class-level PolicyList.
    The keys supported by this operation:
    - POLICYLISTNAME: the PolicyList name
    - CLASSOBJECTNAME: the ClassObject name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyPolicyList
```
public void identifyPolicyList(String tag,
                               String name)
                        throws IfsException
```
    Identify a PolicyList.
    
    Parameters:
    
    tag - the tag to use
    
    name - the PolicyList name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showPolicyList
```
public void showPolicyList(String name)
                    throws IfsException
```
    Show details about a PolicyList.
    
    Parameters:
    
    name - the PolicyList name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllPolicyLists
```
public void showAllPolicyLists()
                        throws IfsException
```
    Shows all of the PolicyLists.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineClassObject
```
public void defineClassObject(AttributeValueTable avt)
                       throws IfsException
```
    Defines a ClassObject definition.
    The keys supported by this operation:
    - CLASSNAME: the name of the ClassObject
    - DESCRIPTION: the ClassObject description
    - SUPERCLASS: the name of the superclass
    - TABLESUFFIX: the suffix to use when naming the tables/view/etc for the ClassObject
    - ABSTRACT: whether the ClassObject is abstract (boolean)
    - FINAL: whether the ClassObject is final (boolean)
    - TABLELESS: whether the ClassObject is tableless (boolean)
    - BEANCLASSPATH: the fully qualified name of the Bean class for this ClassObject
    - SERVERCLASSPATH: the fully qualified name of the Server class for this ClassObject
    - SELECTORCLASSPATH: the fully qualified name of the Selector class for this ClassObject
    - CLASSACLNAME: name identifying a Class-level ACL to assign
    - DEFINITIONCLASSPATH: the fully qualified name of the Defintiion class for this ClassObject
    - DEFINESCLASSDOMAIN: whether this class defines a new ClassDomain (boolean)
    - NEWCLASSDOMAINNAME: the name of the new ClassDomain this ClassObject defines; defaults to the CLASSNAME followed by "..."
    - CREATEPOLICYLIST: whether to create a class-level PolicyList (boolean)
    - INSTALLEDCLASS: whether this is a core ECMSDK class (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineExistingClassObject
```
public void defineExistingClassObject(AttributeValueTable avt)
                               throws IfsException
```
    Defines a definition for an existing ClassObject, for subsequent update.
    The keys supported by this operation:
    - CLASSNAME: the name of the ClassObject
    - DESCRIPTION: the ClassObject description
    - BEANCLASSPATH: the fully qualified name of the Bean class for this ClassObject
    - SERVERCLASSPATH: the fully qualified name of the Server class for this ClassObject
    - SELECTORCLASSPATH: the fully qualified name of the Selector class for this ClassObject
    - DEFINITIONCLASSPATH: the fully qualified name of the Definition class for this ClassObject
    - CREATEPOLICYLIST: whether to create a class-level PolicyList (boolean)
    - INSTALLEDCLASS: whether this is a core ECMSDK class (boolean)
    - CLASSACLNAME: name identifying a Class-level ACL to assign
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - defineAttribute
```
public void defineAttribute(AttributeValueTable avt)
                     throws IfsException
```
    Defines an Attribute definition.
    The keys supported by this operation:
    - CLASSNAME: the ClassObject name
    - ATTRIBUTENAME: the new Attribute's name
    - DESCRIPTION: the new Attribute's description
    - DATATYPE: the data type for the new attribute; one of: String, Date, Boolean, Integer, Long, Double, PublicObject, DirectoryObject, SchemaObject, SystemObject, StringArray, DateArray, BooleanArray, IntegerArray, LongArray, DoubleArray, PublicObjectArray, DirectoryObjectArray, SchemaObjectArray, SystemObjectArray.
    - COLUMNNAME: the name to use for the database column; defaults to the attribute name
    - MAPTABLESUFFIX: the table name suffix to use for the map values, for map data types
    - ARRAYTABLESUFFIX: the table name suffix to use for the array values, for array data types
    - DATALENGTH: the maximum data length (relevant for some data types)
    - DATASCALE: the data scale (relevant for Double data type)
    - REQUIRED: whether the attribute is required (boolean)
    - UNIQUE: whether the attribute values are unique (boolean)
    - INDEXED: whether the attribute is indexed (boolean)
    - SETTABLE: whether the attribute is settable (boolean)
    - UPDATEABLE: whether the attribute is updateable (boolean)
    - EXISTINGCOLUMNNAME: whether an existing column should be used instead of creating a new column implicitly (string)
    - VALUEDEFAULTNAME: the ClassDomain to associate with the attribute
    - CLASSDOMAINNAME: the ClassDomain to associate with the attribute
    - VALUEDOMAINNAME: the ClassDomain to associate with the attribute
    - ISVALUEDOMAINVALIDATED: only relevant when VALUEDOMAINNAME is specified; indicates whether the associated ValueDomain performs strict validation (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - createClassObject
```
public void createClassObject(AttributeValueTable avt)
                       throws IfsException
```
    Creates a ClassObject.
    The primary keys supported by this operation:
    - TAG: the tag that identifies the newly created ClassObject
    - CLASSNAME (or NAME): the name of the newly created ClassObject
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    The legacy keys (when a class definition "TYP" file is used) supported by this operation:
    - CLASSDEFINITIONFILE: the path to the class definition (.typ) file
    - CREATEPROPERTYBUNDLES: whether to create PropertyBundles (boolean)
    - CREATEPOLICYLIST: whether to create a class-level PolicyList (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createOrUpdateClassObject
```
public void createOrUpdateClassObject(AttributeValueTable avt)
                               throws IfsException
```
    Creates or updates a ClassObject.
    The primary keys supported by this operation:
    - TAG: the tag that identifies the ClassObject that was created or modified
    - CLASSNAME (or NAME): the name of the ClassObject to create or modify
    - REMOVEOBSOLETEATTRIBUTES: indicates whether to remove attributes that are not defined
    - VERBOSE: indicates whether the ouput should be verbose
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createClassObject
```
protected ClassObject createClassObject(String className)
                                 throws IfsException
```
    Creates a ClassObject from previously created definitions.
    
    Parameters:
    
    className - the common name for the class (e.g. "DirectoryGroup")
    
    Returns:
    
    the newly created class
    
    Throws:
    
    IfsException - if the operation fails
  - modifyClassObject
```
protected void modifyClassObject(ClassObject co,
                                 String className,
                                 boolean removeAttrs,
                                 boolean verbose)
                          throws IfsException
```
    Modifies the specified ClassObject to match the previously created definitions.
    
    Parameters:
    
    co - the ClassObject to modify
    
    className - the common name for the class (e.g. "DirectoryGroup")
    
    removeAttrs - whether to rmeove Attributes that are no longer defined
    
    verbose - whether output should be verbose
    
    Throws:
    
    IfsException - if the operation fails
  - addAttribute
```
public void addAttribute(AttributeValueTable avt)
                  throws IfsException
```
    Create a new Attribute for an existing ClassObject.
    The keys supported by this operation:
    - CLASSNAME: the ClassObject name
    - ATTRIBUTENAME: the new Attribute's name
    - DESCRIPTION: the new Attribute's description
    - DATATYPE: the data type for the new attribute; one of: String, Date, Boolean, Integer, Long, Double, PublicObject, DirectoryObject, SchemaObject, SystemObject, StringArray, DateArray, BooleanArray, IntegerArray, LongArray, DoubleArray, PublicObjectArray, DirectoryObjectArray, SchemaObjectArray, SystemObjectArray.
    - COLUMNNAME: the name to use for the database column; defaults to the attribute name
    - MAPTABLESUFFIX: the table name suffix to use for the map values, for map data types
    - ARRAYTABLESUFFIX: the table name suffix to use for the array values, for array data types
    - DATALENGTH: the maximum data length (relevant for some data types)
    - DATASCALE: the data scale (relevant for Double data type)
    - REQUIRED: whether the attribute is required (boolean)
    - UNIQUE: whether the attribute values are unique (boolean)
    - INDEXED: whether the attribute is indexed (boolean)
    - SETTABLE: whether the attribute is settable (boolean)
    - UPDATEABLE: whether the attribute is updateable (boolean)
    - REFERENTIALINTEGRITYRULE: the Referential Integrity Rule to use; valid values are CLEAR, RESTRICT, and BEANEXTENSIONS.
    - EXISTINGCOLUMNNAME: whether an existing column should be used instead of creating a new column implicitly (string)
    - VALUEDEFAULTNAME: the ClassDomain to associate with the attribute
    - CLASSDOMAINNAME: the ClassDomain to associate with the attribute
    - VALUEDOMAINNAME: the ClassDomain to associate with the attribute
    - ISVALUEDOMAINVALIDATED: only relevant when VALUEDOMAINNAME is specified; indicates whether the associated ValueDomain performs strict validation (boolean)
    - SKIPIFEXISTS: whether to skip creation if an Attribute with a matching name already exists in the ClassObject (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - removeAttribute
```
public void removeAttribute(AttributeValueTable avt)
                     throws IfsException
```
    Remove an Attribute for an existing ClassObject.
    The keys supported by this operation:
    - CLASSNAME: the ClassObject name
    - ATTRIBUTENAME: the new Attribute's name
    - FREEPROPERTYBUNDLE: whether the Attribute's PropertyBundle should be freed also (boolean)
    - SKIPIFNOTEXISTS: whether to skip the operation if no Attribute exists for the specified name (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - generateClassObjectDefinitionTag
```
protected String generateClassObjectDefinitionTag(String className)
```
    Generate the tag name used for the ClassObjectDefinition used to create or update a ClassObject and its Attributes.
    
    Parameters:
    
    className - the common name for the ClassObject
    
    Returns:
    
    the tag that will define the ClassObjectDefinition
  - setClassObjectCreationMode
```
public void setClassObjectCreationMode(String execMode)
                                throws IfsException
```
    Sets the mode for scripts that create ClassObjects.
    The legal values are: Normal, SkipDomainSettings, and Bootstrap
    
    Parameters:
    
    execMode - the execution mode String
    
    Throws:
    
    IfsException - if the operation fails
  - getClassObjectCreationMode
```
protected int getClassObjectCreationMode()
                                  throws IfsException
```
    Gets the mode for scripts that create ClassObjects.
    The legal values are the integer constants representing: Normal, SkipDomainSettings, and Bootstrap
    
    Returns:
    
    the mode
    
    Throws:
    
    IfsException - if the operation fails
  - isBootstrapModeEnabled
```
protected boolean isBootstrapModeEnabled()
                                  throws IfsException
```
    Gets whether the mode for scripts that create ClassObjects is in bootstrap mode.
    Used by InstallOperations.
    
    Returns:
    
    true if in bootstrap mode
    
    Throws:
    
    IfsException - if the operation fails
  - identifyClassObject
```
public void identifyClassObject(String tag,
                                String name)
                         throws IfsException
```
    Identify a ClassObject.
    
    Parameters:
    
    tag - the tag to use
    
    name - the ClassObject name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showClassObject
```
public void showClassObject(AttributeValueTable avt)
                     throws IfsException
```
    Show a ClassObject.
    The keys supported by this operation:
    - TAG: the tag that identifies the ClassObject
    - NAME: the name of the ClassObject
    - VERBOSE: boolean indication as to whether the output should be detailed
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllClassObjects
```
public void showAllClassObjects(AttributeValueTable avt)
                         throws IfsException
```
    Shows all of the ClassObjects.
    The keys supported by this operation:
    - USECREATIONSYNTAX: boolean to indicate whether the output should resemble a creation script
    - INCLUDEINSTALLEDCLASSES: boolean to indicate whether the output should include core ECMSDK classes
    - INCLUDECUSTOMCLASSES: boolean to indicate whether the output should include non-core (custom) ECMSDK classes
    - VERBOSE: boolean indication as to whether the output should be detailed
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showClassObjectAndSubNames
```
protected void showClassObjectAndSubNames(ClassObject co,
                                          boolean inclInstalled,
                                          boolean inclCustom,
                                          String indent)
                                   throws IfsException
```
    Shows the name of the specified class and each of its subclasses, recursively.
    
    Parameters:
    
    co - the ClassObject to show
    
    inclInstalled - true to include installed classes in the output
    
    inclCustom - true to include custom classes in the output
    
    indent - the indentation
    
    Throws:
    
    IfsException - if the operation fails
  - showClassObjectAndSubs
```
protected void showClassObjectAndSubs(ClassObject co,
                                      boolean createSyntax,
                                      boolean inclInstalled,
                                      boolean inclCustom,
                                      boolean verbose,
                                      boolean showDates)
                               throws IfsException
```
    Shows the specified class and each of its subclasses, recursively
    
    Parameters:
    
    co - the ClassObject to show
    
    createSyntax - true to use create script syntax for the output
    
    inclInstalled - true to include installed classes in the output
    
    inclCustom - true to include custom classes in the output
    
    verbose - true for detailed output
    
    showDates - true to include Dates and other varying info
    
    Throws:
    
    IfsException - if the operation fails
  - showCreateClassObjectScript
```
protected void showCreateClassObjectScript(ClassObject co,
                                           boolean verbose,
                                           boolean showDates)
                                    throws IfsException
```
    Shows the specified class using "create script" syntax.
    
    Parameters:
    
    co - the ClassObject to show
    
    verbose - true for detailed output
    
    showDates - true to include Dates and other varying info
    
    Throws:
    
    IfsException - if the operation fails
  - showDefineAttributeScript
```
protected void showDefineAttributeScript(Attribute attr,
                                         String className,
                                         boolean verbose,
                                         boolean showDates)
                                  throws IfsException
```
    Shows the specified Attribute using "create script" syntax.
    
    Parameters:
    
    attr - the Attribute to show
    
    className - the common name for the class
    
    verbose - true for detailed output
    
    showDates - true to include Dates and other varying info
    
    Throws:
    
    IfsException - if the operation fails
  - freeClassObject
```
public void freeClassObject(AttributeValueTable avt)
                     throws IfsException
```
    Frees a ClassObject.
    The keys supported by this operation:
    - NAME: the ClassObject name
    - TAG: the tag that identifies the ClassObject
    - FREEALLINSTANCES: whether to free all instances of the ClassObject before attempting to free the ClassObject (boolean)
    - FREEUSINGCLASSOBJECT: the ClassObject whose java classes will be used in freeing the instances, as the ClassObject to be freed may no longer have its Java classes available
    - BATCHSIZE: the batch size to use when freeing all instances; defaults to 5000
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyClassPropertyBundle
```
public void identifyClassPropertyBundle(String tag,
                                        String className)
                                 throws IfsException
```
    Identify a ClassObject's property bundle.
    
    Parameters:
    
    tag - the tag to use
    
    className - the ClassObject name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyClassPolicyBundle
```
public void identifyClassPolicyBundle(String tag,
                                      String className)
                               throws IfsException
```
    Identify a ClassObject's Policy bundle.
    
    Parameters:
    
    tag - the tag to use
    
    className - the ClassObject name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeClassProperty
```
public void removeClassProperty(AttributeValueTable avt)
                         throws IfsException
```
    Remove a class-level property.
    The keys supported by this operation:
    - CLASSNAME: the ClassObject name
    - PROPERTYNAME: the new property name
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - identifyAttribute
```
public void identifyAttribute(String tag,
                              String className,
                              String attrName)
                       throws IfsException
```
    Identify an Attribute of a ClassObject.
    
    Parameters:
    
    tag - the tag to use for the Attribute
    
    className - the ClassObject name
    
    attrName - the Attribute name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyAttributePropertyBundle
```
public void identifyAttributePropertyBundle(String tag,
                                            String className,
                                            String attrName)
                                     throws IfsException
```
    Identify an Attribute' Property Bundle.
    
    Parameters:
    
    tag - the tag to use for the Attribute
    
    className - the ClassObject name
    
    attrName - the Attribute name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAttribute
```
public void showAttribute(String tag)
                   throws IfsException
```
    Show details about an Attribute.
    
    Parameters:
    
    tag - the Attribute tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createValueDefault
```
public void createValueDefault(AttributeValueTable avt)
                        throws IfsException
```
    Creates a ValueDefault.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ValueDefault
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the ValueDefault name
    - PROPERTYBUNDLENAME: the ValueDefaultPropertyBundle name; defaults to the ValueDefault name
    - DESCRIPTION: the ValueDefault description
    - ACL: the ACL to use for the embedded ValueDefaultPropertyBundle
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - identifyValueDefault
```
public void identifyValueDefault(String tag,
                                 String name)
                          throws IfsException
```
    Identify a ValueDefault.
    
    Parameters:
    
    tag - the tag to use
    
    name - the ValueDefault name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - assignValueDefault
```
public void assignValueDefault(AttributeValueTable avt)
                        throws IfsException
```
    Assigns a ValueDefault to an Attribute.
    The keys supported by this operation:
    - CLASSOBJECT: the name of the ClassObject whose Attribute will be updated
    - ATTRIBUTE: the Attribute name
    - VALUEDEFAULT: the name of the ValueDefault to assign
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showValueDefault
```
public void showValueDefault(String name)
                      throws IfsException
```
    Show details about a ValueDefault.
    
    Parameters:
    
    name - the ValueDefault name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showValueDefault
```
public void showValueDefault(AttributeValueTable avt)
                      throws IfsException
```
    Shows a ValueDefault.
    The keys supported by this operation:
    - TAG: the tag that identifies the ValueDefault
    - NAME: the name of the ValueDefault
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllValueDefaults
```
public void showAllValueDefaults()
                          throws IfsException
```
    Shows all of the ValueDefaults.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateValueDefault
```
public void updateValueDefault(AttributeValueTable avt)
                        throws IfsException
```
    Updates a ValueDefault.
    The keys supported by this operation:
    - TAG: the tag that identifies the ValueDefault to update
    - NAME: the ValueDefault name that identifies the ValueDefault to update
    Either TAG or NAME must be specified to identify the ValueDefault to update.
    To update a ValueDefault's value, specify value using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - freeValueDefault
```
public void freeValueDefault(AttributeValueTable avt)
                      throws IfsException
```
    Frees a ValueDefault.
    The keys supported by this operation:
    - NAME: the ValueDefault name
    - TAG: the tag that identifies the ValueDefault
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createValueDomain
```
public void createValueDomain(AttributeValueTable avt)
                       throws IfsException
```
    Creates a ValueDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ValueDomain
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the ValueDomain name
    - DESCRIPTION: the ValueDomain description
    - ACL: the ACL to use for the embedded ValueDomainPropertyBundle
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    The property value is specified using one of the keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - assignValueDomain
```
public void assignValueDomain(AttributeValueTable avt)
                       throws IfsException
```
    Assigns a ValueDomain to an Attribute.
    The keys supported by this operation:
    - CLASSOBJECT: the name of the ClassObject whose Attribute will be updated
    - ATTRIBUTE: the Attribute name
    - VALUEDOMAIN: the name of the ValueDomain to assign
    - VALIDATED: whether the ValueDomain should be validated
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyValueDomain
```
public void identifyValueDomain(String tag,
                                String name)
                         throws IfsException
```
    Identify a ValueDomain.
    
    Parameters:
    
    tag - the tag to use
    
    name - the ValueDomain name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showValueDomain
```
public void showValueDomain(String name)
                     throws IfsException
```
    Show details about a ValueDomain.
    
    Parameters:
    
    name - the ValueDomain name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showValueDomain
```
public void showValueDomain(AttributeValueTable avt)
                     throws IfsException
```
    Shows a ValueDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the ValueDomain
    - NAME: the name of the ValueDomain
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllValueDomains
```
public void showAllValueDomains()
                         throws IfsException
```
    Shows all of the ValueDomains.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateValueDomain
```
public void updateValueDomain(AttributeValueTable avt)
                       throws IfsException
```
    Updates a ValueDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the ValueDomain to update
    - NAME: the ValueDomain name that identifies the ValueDomain to update
    Either TAG or NAME must be specified to identify the ValueDomain to update.
    To update a ValueDomain's set of enumerated values, specify values with an AttributeValue of an array type, using one of the array type keys listed in getAttributeValue.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    getAttributeValue(AttributeValueTable, String[])
    
    (Published)
  - freeValueDomain
```
public void freeValueDomain(AttributeValueTable avt)
                     throws IfsException
```
    Frees a ValueDomain.
    The keys supported by this operation:
    - NAME: the ValueDomain name
    - TAG: the tag that identifies the ValueDomain
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createClassDomain
```
public void createClassDomain(AttributeValueTable avt)
                       throws IfsException
```
    Creates a ClassDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created ClassDomain
    - DEFTAG: the definition tag to use as the base definition (optional)
    - NAME: the ClassDomain name
    - DESCRIPTION: the ClassDomain description
    - CLASSNAMES: the array of ClassObject names
    - INCLUDESUBCLASSES: whether or not subclasses should be included
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - assignClassDomain
```
public void assignClassDomain(AttributeValueTable avt)
                       throws IfsException
```
    Assigns a ClassDomain to an Attribute.
    The keys supported by this operation:
    - CLASSOBJECT: the name of the ClassObject whose Attribute will be updated
    - ATTRIBUTE: the Attribute name
    - CLASSDOMAIN: the name of the ClassDomain to assign
    - SKIPIFNOTEXISTS: whether to skip if the ClassDomain or Attribute do not exist (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyClassDomain
```
public void identifyClassDomain(String tag,
                                String name)
                         throws IfsException
```
    Identify a ClassDomain.
    
    Parameters:
    
    tag - the tag to use
    
    name - the ClassDomain name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showClassDomain
```
public void showClassDomain(String name)
                     throws IfsException
```
    Show details about a ClassDomain.
    
    Parameters:
    
    name - the ClassDomain name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showClassDomain
```
public void showClassDomain(AttributeValueTable avt)
                     throws IfsException
```
    Shows a ClassDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the ClassDomain
    - NAME: the name of the ClassDomain
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllClassDomains
```
public void showAllClassDomains()
                         throws IfsException
```
    Shows all of the ClassDomains.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateClassDomain
```
public void updateClassDomain(AttributeValueTable avt)
                       throws IfsException
```
    Updates a ClassDomain.
    The keys supported by this operation:
    - TAG: the tag that identifies the ClassDomain to update
    - NAME: the ClassDomain name that identifies the ClassDomain to update
    - DEFTAG: the definition tag to use as the base definition (optional)
    - CLASSNAMES: the array of ClassObject names (optional)
    - INCLUDESUBCLASSES: whether or not subclasses should be included (optional)
    Either TAG or NAME must be specified to identify the ClassDomain to update.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeClassDomain
```
public void freeClassDomain(AttributeValueTable avt)
                     throws IfsException
```
    Frees a ClassDomain.
    The keys supported by this operation:
    - NAME: the ClassDomain name
    - TAG: the tag that identifies the ClassDomain
    - SKIPIFNOTEXISTS: whether to skip free if an object with a matching name does not exist (boolean)
    Either TAG or NAME must be specified.
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDependentView
```
public void createDependentView(AttributeValueTable avt)
                         throws IfsException
```
    Creates a DependentView.
    The keys supported by this operation:
    - TAG: the tag that identifies the newly created DependentView
    - DEFTAG: the definition tag to use as the base definition
    - NAME: the DependentView name
    - VIEWBODY: the DependentView CREATE OR REPLACE VIEW statement
    - DEPENDENTCLASSOBJECTS: the list of ClassObject names that the view depends upon
    - SKIPIFEXISTS: whether to skip creation if an object with a matching name already exists (boolean)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - identifyDependentView
```
public void identifyDependentView(String dvTag,
                                  String name)
                           throws IfsException
```
    Identifies a DependentView by its unique name.
    
    Parameters:
    
    dvTag - the DependentView tag
    
    name - the DependentView name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDependentView
```
public void showDependentView(String dvTag)
                       throws IfsException
```
    Show details about a DependentView.
    
    Parameters:
    
    dvTag - the DependentView tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showAllDependentViews
```
public void showAllDependentViews()
                           throws IfsException
```
    Shows all of the DependentViews.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - refreshDependentView
```
public void refreshDependentView(String dvTag)
                          throws IfsException
```
    Refresh the view using the definition contained in a DependentView.
    
    Parameters:
    
    dvTag - the DependentView tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFolder
```
public void createFolder(String folderTag,
                         String parentTag,
                         String folderName)
                  throws IfsException
```
    Create a new folder. The parent tag must refer to either another regular folder or to a workspace.
    
    Parameters:
    
    folderTag - the folder tag
    
    parentTag - the tag of the parent folder under which the new folder will be created
    
    folderName - the folder name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFolder
```
public void createFolder(String folderTag,
                         String parentTag,
                         String folderName,
                         String defTag)
                  throws IfsException
```
    Create a new folder. The parent tag must refer to a folder.
    
    Parameters:
    
    folderTag - the folder tag
    
    parentTag - the tag of the parent folder under which the new folder will be created
    
    folderName - the folder name
    
    defTag - the folder def
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFolder
```
public void createFolder(AttributeValueTable avt)
                  throws IfsException
```
    Creates a Folder.
    The keys supported by this operation:
    - TAG: the tag that will identify the new object
    - NAME: the Folder name
    - DESCRIPTION: the Folder description
    - ACL: the ACL to use for the new Folder
    - PARENTFOLDER: the tag of the parent folder
    - CATEGORYNAME: the Name to use for a Category instance
    - CATEGORYCLASS: the Class to use for a Category instance
    - CATEGORYDEFTAG: a CategoryDefinition that completely defines a Category to be added to the Folder
    - AUTOFOLDERINGACTIONSPECIFICATION: the auto foldering spec
    - DEFTAG: a FolderDefinition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - freeFolder
```
public void freeFolder(AttributeValueTable avt)
                throws IfsException
```
    Frees a Folder.
    The keys supported by this operation:
    - TAG: the tag that will identify the object to be freed
    - DEEP (or FREEALLITEMS): boolean option indicating that all contained items will also be freed recursively.
    - FOLDERMUSTBEEMPTY: boolean option indicating that the folder must be empty
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFolderTree
```
public void createFolderTree(AttributeValueTable avt)
                      throws IfsException
```
    Creates a folder tree for all folders missing in the specified absolute path.
    The keys supported by this operation:
    - PATH: the absolute path of the lowest folder that should be created if it does not already exist
    - ACL: ACL to use for all Folders (defaults to Public)
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - createDocument
```
public void createDocument(String docTag,
                           String parentTag,
                           String docName,
                           String defTag)
                    throws IfsException
```
    Create a document. If there is already a document with the specified name in the target folder, add the new Document as a version to the target, based on the VersioningConfiguration of the folder.
    
    Parameters:
    
    docTag - the document tag
    
    parentTag - the tag of the parent folder upon which the new document will be created
    
    docName - the document name
    
    defTag - the document def
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDocument
```
public void createDocument(String docTag,
                           String parentTag,
                           String docDefTag)
                    throws IfsException
```
    Create a document, using a DocumentDefintion.
    The name must already be set in the definition.
    
    Parameters:
    
    docTag - the document tag
    
    parentTag - the tag of the parent folder upon which the new document will be created
    
    docDefTag - the tag identifying the DocumentDefinition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDocument
```
public void createDocument(AttributeValueTable avt)
                    throws IfsException
```
    Creates a Document.
    The keys supported by this operation:
    - TAG: the tag that will identify the new object
    - NAME: the Document name
    - DESCRIPTION: the Document description
    - ACL: the ACL to use for the new Document
    - PARENTFOLDER: the tag of the parent folder
    - AUTOFOLDERINGACTIONSPECIFICATION: the auto foldering spec
    - FILE: the file name for the content, relative to IFSROOT
    - LITERALCONTENT: the actual content of the document, as a String
    - BFILENAME: the name of the BFILE, if BFILE content ref is specified
    - BFILEFOLDER: the absolute path to the BFILE folder, if BFILE content ref is specified
    - BFILELENGTH: the file length of the BFILE (optional)
    - EMPTYCONTENT: if the Document should have no content
    - ENCRYPT: whether to encrypt the content (optional)
    - FORMAT: the Format for the content
    - MEDIA: the Media for the content
    - CHARACTERSET: the Character set to use
    - CATEGORYNAME: the Name to use for a Category instance
    - CATEGORYCLASS: the Class to use for a Category instance
    - CATEGORYDEFTAG: a CategoryDefinition that completely defines a Category to be added to the Document
    - DEFTAG: a DocumentDefinition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createDocumentBatch
```
public void createDocumentBatch(AttributeValueTable avt)
                         throws IfsException
```
    Creation a batch of Documents from an input file directory.
    The keys supported by this operation:
    - PARENTFOLDER: the parent folder for all InformationExtractions
    - FILEDIRECTORY: the file directory
    - ACL: the ACL to use for the new Document
    - FORMAT: the Format for the content
    - MEDIA: the Media for the content
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
  - createDocuments
```
protected int createDocuments(String dirPath,
                              Folder topFolder,
                              AccessControlList acl,
                              Format format,
                              Media media)
                       throws IfsException
```
    Produce a list of files found under the specified absolute directory path.
    
    Parameters:
    
    dirPath - the absolute directory path
    
    topFolder - the parent folder
    
    acl - the ACL to use
    
    format - the Format to use
    
    media - the Media to use
    
    Returns:
    
    the count of Documents created
    
    Throws:
    
    IfsException
    
    (Published)
  - createCategorizedDocument
```
public void createCategorizedDocument(String docTag,
                                      String parentTag,
                                      String docName,
                                      String contentFileName,
                                      String catDefTag)
                               throws IfsException
```
    Create a document with a category, as specified by a category defintiion tag.
    If there is already a document with the specified name in the target folder, add the new Document as a version to the target, based on the VersioningConfiguration of the folder.
    
    Parameters:
    
    docTag - the document tag
    
    parentTag - the tag of the parent folder upon which the new document will be created
    
    docName - the document name
    
    contentFileName - the name of the file to be used for content
    
    catDefTag - the category definition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addCategory
```
public void addCategory(AttributeValueTable avt)
                 throws IfsException
```
    Adds a category to an existing PublicObject.
    The keys supported by this operation:
    - PUBLICOBJECT: the tag that will identify the PublicObject
    - CATEGORYDEFTAG: the CategoryDefinition tag
    - CATEGORYTAG: optional tag that will identify the newly created Category
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLink
```
public void createLink(AttributeValueTable avt)
                throws IfsException
```
    Creates a Link.
    The keys supported by this operation:
    - TAG: the tag that will identify the new object
    - NAME: the object name
    - DESCRIPTION: the object description
    - ACL: the ACL to use for the new object
    - ASSOCIATEDPUBLICOBJECT: the object to link to
    - DEFTAG: a Definition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createFolderLink
```
public void createFolderLink(AttributeValueTable avt)
                      throws IfsException
```
    Creates a FolderLink.
    The keys supported by this operation:
    - TAG: the tag that will identify the new object
    - NAME: the object name
    - DESCRIPTION: the object description
    - ACL: the ACL to use for the new object
    - ASSOCIATEDPUBLICOBJECT: the object to link to
    - DEFTAG: a Definition containing additional options
    Parameters:
    
    avt - the named arguments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLink
```
public void createLink(String linkTag,
                       String parentTag,
                       String defTag)
                throws IfsException
```
    Creates a link using a LinkDefinition.
    
    Parameters:
    
    linkTag - the link tag
    
    parentTag - the tag of the parent folder in which the new link will be created
    
    defTag - the link definition tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createLink
```
public void createLink(String linkTag,
                       String parentTag,
                       String name,
                       String assocTag)
                throws IfsException
```
    Creates a link.
    
    Parameters:
    
    linkTag - the link tag
    
    parentTag - the tag of the parent folder in which the new link will be created
    
    name - the link name
    
    assocTag - the tag of the document or folder the new link will point to
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDocument
```
public void showDocument(String docTag)
                  throws IfsException
```
    Show details about a document.
    
    Parameters:
    
    docTag - the document tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDocumentContentInfo
```
public void showDocumentContentInfo(String docTag)
                             throws IfsException
```
    Show details about a document's content.
    
    Parameters:
    
    docTag - the document tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDocumentContents
```
public void showDocumentContents(String docTag)
                          throws IfsException
```
    Show a document's content.
    
    Parameters:
    
    docTag - the document tag
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - showDocumentLanguage
```
public void showDocumentLanguage(String docTag)
                          throws IfsException
```
    Deprecated. 9.0.4.6: use showDocumentContentInfo
    
    Show language of document.
    
    Parameters:
    
    docTag - the document tag
    
    Throws:
    
    IfsException - if the operation fails
  - showDocumentCharacterSet
```
public void showDocumentCharacterSet(String docTag)
                              throws IfsException
```
    Deprecated. 9.0.4.6: use showDocumentContentInfo
    
    Show character set of document.
    
    Parameters:
    
    docTag - the document tag
    
    Throws:
    
    IfsException - if the operation fails
  - showDocumentContents
```
protected void showDocumentContents(Document doc,
                                    String prefix)
                             throws IfsException
```
    Show a Document's content, using its Reader.
    
    Parameters:
    
    doc - the Document to show
    
    prefix - the indentation prefix
    
    Throws:

Class ScriptOperations

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INDENT

Constructor Detail

ScriptOperations

Method Detail

getDriver

getLogWriter

getAuditDriverHelper

getShowDates

getStripNumbersFromAuditEventProperties

constructPreparedSelectorGenerator

constructPreparedSelectorGenerator

isDomainScopeImpliedForSearch

showLibraryObject

setDefaultScriptOperationsClass

runScript

createSession

createSession

setCurrentSession

removeSession

cloneCurrentSession

setDateFormat

setNumberFormat

setArrayTokenDelimiter

setSubstitutionPrefix

showParsedArrayToken

showParsedOperationString

setTimeZone

setLocale

showLocalizer

createGuestSession

createUserSession

showUser

showCurrentUser

beginTransaction

abortTransaction

completeTransaction

markCurrentAuditingId

setDefaultAuditEventSortClause

processRawAuditEvents

handleEventPostedForCustomAuditHistory

handleTimerExpiredForCustomAuditHistory

notifyCustomAuditHistoryHandler

postCustomAuditEvent

postCustomAuditEvent

postCustomAuditEvent

postSystemAuditEvent

postSystemAuditEvent

constructAuditEvent

addAuditEventProperty

showGlobalAuditHistory

showGlobalAuditHistory

purgeGlobalAuditHistory

setGlobalAuditTypeList

identifyGlobalAuditTypeList

showGlobalAuditTypeList

showObjectAuditHistory

showObjectAuditHistory

showCustomAuditHistory

showCustomAuditHistory

searchAuditHistory

searchAuditHistory

searchAuditHistory

showAggregateAuditEventColumns

showAuditCertificates

showAuditEventOperationTypes

showAuditTypesForClass

showAuditTypesUnderClass

showAuditTypesForCreateOperations

showAuditTypesForFreeOperations

unregisterAuditEventType

registerAuditEventType

registerAuditEventType

showCustomAuditTypes