A B C D E F G H I J K L M N O P Q R S T U V W X

A

ABOUT_TOPIC_KEY_CRR_BUILD_DATE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_CRR_EDITION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_CRR_URL - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_CRR_VERSION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_DEFAULT_LOCALE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_DIAGNOSTICS_EMAIL_ADDRESS - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_DIAGNOSTICS_EMAIL_SUBJECT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_DIAGNOSTICS_TEMPLATE_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_CONNECTION_TIMEOUT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_REPLYTO - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_SMTP_AUTH_ENABLED - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_SMTP_HOST - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_SMTP_PORT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_EMAIL_USERNAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_JRE_VERSION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_OS - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_USER_DISPLAY_LANGUAGE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_KEY_USER_LOCALE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_COPYRIGHT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_DIAGNOSTICS_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_EMAIL_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_SYSTEM_INFORMATION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_TECH_INFO - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_TITLE_USER_DETAILS - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_COPYRIGHT_1 - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_COPYRIGHT_2 - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_COPYRIGHT_3 - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_COPYRIGHT_4 - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_COPYRIGHT_5 - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_CRR_EDITION_ACTIVE_SOA - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
ABOUT_TOPIC_VALUE_CRR_EDITION_COMMUNITY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
AboutTopic - Interface in com.softwareag.centrasite.api.about
Represents a topic in the about dialog
AboutTopicValue - Interface in com.softwareag.centrasite.api.about
Represents a value under each AboutTopic
ACL - Interface in com.softwareag.centrasite.api.csom
 
ACL_PRIVILEGE_FULL - Static variable in interface com.softwareag.centrasite.api.csom.ACL
Read, write and delete privileges over the object
ACL_PRIVILEGE_NONE - Static variable in interface com.softwareag.centrasite.api.csom.ACL
No privilege over the object
ACL_PRIVILEGE_READ - Static variable in interface com.softwareag.centrasite.api.csom.ACL
Only read privilege over the object
ACL_PRIVILEGE_WRITE - Static variable in interface com.softwareag.centrasite.api.csom.ACL
Only read and write privileges over the object
ACTION_ATTRIBUTE_BULK - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_CLASS_NAME - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_GROUP - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_ICON - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_ID - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_INBOX - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_IS_ALLOWED_FOR_GUEST - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_PROTECTED - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_ATTRIBUTE_TIMEOUT - Static variable in class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ACTION_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent CSOActionManager implementation class.
ACTION_PATH - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
ActionConstants - Class in com.softwareag.centrasite.api.csom.action
The ActionConstants class includes constants related to the CentraSite Action module.
ActionConstants() - Constructor for class com.softwareag.centrasite.api.csom.action.ActionConstants
 
ActionStateEnum - Enum in com.softwareag.centrasite.api.csom.action
 
Activity - Interface in com.softwareag.centrasite.api.activity
Activity which helps to trigger the operations supported by the activity implementation class.
ACTIVITY_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent ActivityManager implementation class.
ActivityManager - Interface in com.softwareag.centrasite.api.activity
ActivityManager is an interface for activity and activity menu management.
ActivityMenu - Interface in com.softwareag.centrasite.api.activity
ActivityMenu which holds the available ActivityMenuItems.
ActivityMenuItem - Class in com.softwareag.centrasite.api.activity
This class represent the ActivityMenuItem in the ActivityMenu and holds a reference the Activity implementation class.
ActivityMenuItem(Activity) - Constructor for class com.softwareag.centrasite.api.activity.ActivityMenuItem
 
addLocalizedString(CentraSiteLocalizedString) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Adds a CentraSiteLocalizedString to this object.
addLocalizedStrings(Collection<CentraSiteLocalizedString>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Adds many CSOLocalizedStrings to this object.
addTelephoneNumber(TelephoneNumber, String) - Method in interface com.softwareag.centrasite.api.csom.User
Deprecated.  
AddToListAction - Interface in com.softwareag.centrasite.api.csom.action
The AddToListAction interface allows build a collection of objects that can display as a group.
APPLICABLE_LCM - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
APPLICABLE_LCSTATES - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
ApproveAction - Interface in com.softwareag.centrasite.api.csom.action
The ApproveAction interface contains various methods that enable defining and retrieving comments for approving a request.
Assets - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
 
AssetSupportedOption - Enum in com.softwareag.centrasite.api.csom.action
AssetSupportedOption enum indicates the asset option
AssetTypes - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOParameterType
 
AttachDocumentAction - Interface in com.softwareag.centrasite.api.csom.action
The AttachDocumentAction interface provides a mechanism to attach a document either as InputStream or URI.
AttachDocumentState - Enum in com.softwareag.centrasite.api.csom.action
AttachDocumentState will have the states possible for transition in case of attach document action.
ATTRIBUTE_EMAIL_MIMETYPE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
ATTRIBUTE_EMAIL_TEMPLATE_NAME - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
ATTRIBUTE_KEY_SLOT - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
ATTRIBUTE_NAME_PROTECTED - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 

B

BASE_PATH_OF_SEARCH - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
BROWSABLE_TAXONOMIES - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 

C

CAN_INHERIT_PROFILE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
cancel() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Cancels the execution of remaining steps and moves the state to 'complete' for this action.
canCreateAsset(Organization) - Method in interface com.softwareag.centrasite.api.csom.User
Check if the user has privilege to create an asset instance in the given organization.
canDelete(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.User
Check if the user has privilege to delete the given RegistryObject.
canHaveImporter() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
return true in case the asset type have importer which imports the asset with the given meta data file. other wise false.
canModify(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.User
Check if the user has privilege to modify the given CentraSiteRegistryObject.
canMove() - Method in interface com.softwareag.centrasite.api.csom.action.EditAction
Checks if the logged in user has permission to change the ownership of a CentraSite object.
canRender() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
Checks if the computed profile can be UI rendering
CATEGORIES_BY_KEYWORD - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
CATEGORIES_BY_KEYWORD_AND_TAXONOMY - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
Category - Interface in com.softwareag.centrasite.api.csom
The Category interface is used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy.
CENTRASITE_CONNECTOR_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent CentrasiteConnector implementation class.
CENTRASITE_OBJECT - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
CENTRASITE_REPOSITORY_FILE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
CENTRASITE_REPOSITORY_FOLDER - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
CENTRASITE_WEB_DAV_URI - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
CentraSiteFile - Interface in com.softwareag.centrasite.api.csom.repository
CentraSiteFile represents any type of file in CentraSite
CentraSiteInternationalString - Interface in com.softwareag.centrasite.api.csom
CentraSiteInternationalString which the holds the information of available indifferent locale's.
CentraSiteLocalizedString - Interface in com.softwareag.centrasite.api.csom
This interface is used as a simple wrapper interface that associates a String with its Locale.
CentraSiteObject - Interface in com.softwareag.centrasite.api.csom
CentraSiteObject is the base class for the CentraSiteObjectModel.
CentraSiteObjectAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
Depicts an attribute of any CentraSiteObject.
CentraSiteObjectAttributeDataType - Interface in com.softwareag.centrasite.api.csom.attribute
 
CentraSiteObjectManager - Interface in com.softwareag.centrasite.api.csom
CentraSiteObjectManager is used to manage the CentraSiteObjects, using this manager we can perform the operations like
1) Create the CentraSiteObject based on the given CentraSiteObjectType.
CentraSiteObjectType - Interface in com.softwareag.centrasite.api.csom.type
CentraSiteObjectType represents the type definition for CentraSiteObject & holds the information related to that specific type All the CentraSite model objects can be identified by using the QName, because for identifying these objects we may require the schema also.
CentraSiteObjectTypeManager - Interface in com.softwareag.centrasite.api.csom.type
CentraSiteObjectTypeManager used to populate the CentraObjectType based on the different criteria.
CentraSiteRegistryObject - Interface in com.softwareag.centrasite.api.csom
CentraSiteRegistryObject is used to represent the CentraSite Registry objects.
CentraSiteRegistryObjectType - Interface in com.softwareag.centrasite.api.csom.type
CentraSiteObjectType represents the type definition for CentraSiteObject & holds the information related to that specific type

1.
CentraSiteRepositoryFile - Interface in com.softwareag.centrasite.api.csom.repository
CentraSiteRepositoryFile represents a file in CentraSite Repository
CentraSiteRepositoryFolder - Interface in com.softwareag.centrasite.api.csom.repository
CentraSiteRepositoryFolder which represents a physical folder in the repository through which which can access it's sub folders and files.
CentraSiteRepositoryObject - Interface in com.softwareag.centrasite.api.csom.repository
CentraSiteRepositoryObject represents any object in CentraSite Repository
CentraSiteService - Interface in com.softwareag.centrasite.api.service
CentraSiteService which provides the services like provide the CentraSiteSession, which is the entry point for getting instances of managers like CentraSiteObjectManager CentraSiteObjectTypeManager CSOSearchManager and also DiagnosticHandler
The CentraSiteService instantiated by using CentraSiteServiceFactory.
CentraSiteServiceFactory - Class in com.softwareag.centrasite.api.service
CentraSiteServiceFactory which instantiates the CentraSiteService based on the user inputs
CentraSiteSession - Interface in com.softwareag.centrasite.api.session
CentraSiteSession interface provides instances of the CentraSite Object managers, and other specialized programs such as configurators, diagnostic handlers etc., based on the user who is currently mapped to the session.
CENTRASITETYPES_KEY_Versionable - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
CHAR_DOT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
CHAR_EXCLAMATORY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
CLASSIFICATION - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
ClassificationAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
ClassificationAttribute interface represents the classification based on attribute of a CentraSiteObject.
ClassificationCondition - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Used to mark the condition to be a Classification condition
ClientAboutInfo - Interface in com.softwareag.centrasite.api.about
Represents the about information which any client can provide
CLLConstants - Interface in com.softwareag.centrasite.api.common.constants
Class to hold the constants used in CentraSite Logic layer.
CLLException - Exception in com.softwareag.centrasite.api.common.exception
Utility class that wraps all exceptions into the CLLException
CLLException(CLLMessage) - Constructor for exception com.softwareag.centrasite.api.common.exception.CLLException
 
CLLException(CLLMessage, Throwable) - Constructor for exception com.softwareag.centrasite.api.common.exception.CLLException
 
CLLMessage - Class in com.softwareag.centrasite.api.common.i18nresource
 
CLLMessage(String, Locale, Object...) - Constructor for class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
 
clone() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
 
close() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Closes a service and releases all resources.
close() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Closes a session, releases all resources, and performs an implicit logout.
com.softwareag.centrasite.api.about - package com.softwareag.centrasite.api.about
 
com.softwareag.centrasite.api.activity - package com.softwareag.centrasite.api.activity
 
com.softwareag.centrasite.api.common.constants - package com.softwareag.centrasite.api.common.constants
 
com.softwareag.centrasite.api.common.exception - package com.softwareag.centrasite.api.common.exception
 
com.softwareag.centrasite.api.common.i18nresource - package com.softwareag.centrasite.api.common.i18nresource
 
com.softwareag.centrasite.api.configurator - package com.softwareag.centrasite.api.configurator
 
com.softwareag.centrasite.api.csom - package com.softwareag.centrasite.api.csom
 
com.softwareag.centrasite.api.csom.action - package com.softwareag.centrasite.api.csom.action
 
com.softwareag.centrasite.api.csom.attribute - package com.softwareag.centrasite.api.csom.attribute
 
com.softwareag.centrasite.api.csom.repository - package com.softwareag.centrasite.api.csom.repository
 
com.softwareag.centrasite.api.csom.search - package com.softwareag.centrasite.api.csom.search
 
com.softwareag.centrasite.api.csom.search.validation - package com.softwareag.centrasite.api.csom.search.validation
 
com.softwareag.centrasite.api.csom.type - package com.softwareag.centrasite.api.csom.type
 
com.softwareag.centrasite.api.diagnostic - package com.softwareag.centrasite.api.diagnostic
 
com.softwareag.centrasite.api.service - package com.softwareag.centrasite.api.service
 
com.softwareag.centrasite.api.session - package com.softwareag.centrasite.api.session
 
COM_WEBMETHODS_SC_CONFIG_CONFIG_ROOT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
CommonAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
CommonAttribute interface represents the set of generic attributes of a CentraSiteObject.
ComparisonCondition - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Used to mark the condition to be a comparison condition
ComputedProfile - Interface in com.softwareag.centrasite.api.csom.type
Computed profiles and attributes provide a dynamic rendering of information for assets.
CONFIG_BASE_DIR - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
Configurator - Interface in com.softwareag.centrasite.api.configurator
 
CONFIGURATOR_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent Configurator implementation class.
ConfiguratorConstants - Interface in com.softwareag.centrasite.api.configurator
 
ConfiguratorItem - Class in com.softwareag.centrasite.api.configurator
 
ConfiguratorItem(String, String, HashMap<String, String>) - Constructor for class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
CONN_FACTORY_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent the Connection factory class.
ConsumeAction - Interface in com.softwareag.centrasite.api.csom.action
The ConsumerAction facilitates to consume the assets with CentraSiteObject.
containsValue(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Check whether one of the localized strings is equal to the given value.
createActivity(String, String) - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
Create an activity by using given parameters.
createActivityMenuItem(Activity) - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
create the Menu Item using given activity.
CreateAssetActivity - Interface in com.softwareag.centrasite.api.activity
The CreateAssetActivity enables you to create an asset from scratch with or without a file import.
createCLLException(String, Throwable, Object...) - Static method in exception com.softwareag.centrasite.api.common.exception.CLLException
Constructs a CLLException with the specified parameters.
createCondition(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchConditionManager
Creates the search condition based on the given name
createDiagnosticContext(CLLException, Properties) - Method in interface com.softwareag.centrasite.api.diagnostic.DiagnosticHandler
Instantiate the DiagnosticContext with the given exception and properties.
createDiagnosticContext(CLLException, CentraSiteRegistryObject, Properties) - Method in interface com.softwareag.centrasite.api.diagnostic.DiagnosticHandler
Instantiate the DiagnosticContext with the given exception and properties
createInternationalString() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates an empty CentraSiteInternationalString.
createInternationalString(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates an empty CentraSiteInternationalString with the specified value and default locale.
createInternationalString(Locale, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates an empty CentraSiteInternationalString with the specified locale and value.
createLocaleFromStr(String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
createLocalizedString(Locale, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates a CentraSiteLocalizedString instance with the specified Locale and string parameters.
createLocalizedString(Locale, String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates a CentraSiteLocalizedString instance with the specified Locale, string, and character set parameters.
createNewVersion(CentraSiteRegistryObject, String, Organization, boolean, String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates a new version of the given object.
createNewVersion(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Creates a new version of the given object.
createObject(CentraSiteObjectType) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Create the CentraSiteObject for the given CentraSiteObjectType.
createSearch() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Creates a search object that can be used for keyword and advanced searches.
createSearchScope(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Creates a search scope based on the given name
createSearchScope(Collection<CentraSiteRegistryObjectType>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Creates a CSOSearchScope object from a collection of CSOTypes.
createService() - Method in class com.softwareag.centrasite.api.service.CentraSiteServiceFactory
Creates a service that gets its configuration via the pre-configured property com.softwareag.centrasite.api.configuration.basedir
createService(String) - Method in class com.softwareag.centrasite.api.service.CentraSiteServiceFactory
Creates a service that gets its configuration from the directory given by the string argument.
createService(Properties) - Method in class com.softwareag.centrasite.api.service.CentraSiteServiceFactory
Creates a service that gets its configuration via properties.
createSession() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Creates an anonymous session that is mapped to guest access. if Guest access can be disabled which results that this method will return null
createSession(ITomcatSettings) - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Creates an anonymous session that is mapped to guest access. if Guest access can be disabled which results that this method will return null
createSession(Collection<Object>) - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Creates a session based on the passed authentication information which can be Password authentication or SSO information.
createSession(Collection<Object>, ITomcatSettings) - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Creates a session based on the passed authentication information which can be Password authentication or SSO information.
createSortSpecifier(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Create an instance for CSOSortSpecifier using the given CentraSiteObjectAttribute.
createSortSpecifier(CentraSiteObjectAttribute, CSOSortSpecifier.Direction) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Create the instance for CSOSortSpecifier by given CentraSiteObjectAttribute and Direction.
CSOAction - Interface in com.softwareag.centrasite.api.csom.action
The CSOAction interface represents any action that can be performed on a CentraSiteObject.
CSOActionManager - Interface in com.softwareag.centrasite.api.csom.action
The CSOActionManager interface manages all actions that are defined
for CentraSiteObject(s).
CSOComputedAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
CSOComputedAttribute interface represents the computed attributes of a CentraSiteObject.
CSOLink - Interface in com.softwareag.centrasite.api.csom.search
Provides access through the link type and its parameters through the CSO.getAttributeValue() method.
CSOMConstants - Interface in com.softwareag.centrasite.api.common.constants
This the interface which holds the constants used by the CSOM.
CSOParameter - Interface in com.softwareag.centrasite.api.csom.search
This model is used to represent the parameters saved in report search definition.
CSOParameterType - Interface in com.softwareag.centrasite.api.csom.search
interface which defines the various parameter type constants.
CSOSearch - Interface in com.softwareag.centrasite.api.csom.search
This interface can be used to perform search operation on CentraSite Objects.
CSOSearch.SearchType - Enum in com.softwareag.centrasite.api.csom.search
Enumeration that differentiate the types of searches
CSOSearchCondition - Interface in com.softwareag.centrasite.api.csom.search
CSOSearchCondition represent the search criteria/filters in a generic way.
CSOSearchConditionManager - Interface in com.softwareag.centrasite.api.csom.search
The CSOSearchConditionManager supports comparison conditions, keyword conditions customer defined conditions
that can be specified in the CLL configuration.
CSOSearchManager - Interface in com.softwareag.centrasite.api.csom.search
The CSOSearchManager provides the interface for searching the CSOM.
CSOSearchResult - Interface in com.softwareag.centrasite.api.csom.search
The CSOSearchResult provides a collection of result items where each result item is assumed to be a CentraSiteObject.
CSOSearchScope - Interface in com.softwareag.centrasite.api.csom.search
The CSOSearchScope determines which objects are affected by the search.
CSOSortSpecifier - Interface in com.softwareag.centrasite.api.csom.search
The order of a search result is defined by a list of CSSortSpecifier.
CSOSortSpecifier.Direction - Enum in com.softwareag.centrasite.api.csom.search
 
CSOUriGenerator - Interface in com.softwareag.centrasite.api.session
The URI format is not fixed but greatly depends on the CSO client.
CSOValidationInfo - Interface in com.softwareag.centrasite.api.csom.search.validation
CSOValidationInfo captures the information about the error prone Search elements and severity of the error prone.
CSROProfile - Interface in com.softwareag.centrasite.api.csom.type
The CSROProfile object is a logical wrapper to represent the CentraSiteObjectAttributes detail of a CentraSiteRegistryObject.getProfiles methods can be used to obtain the associated profiles at instance level
CustomCondition - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Used to mark the condition to be a custom condition

D

DECIMAL - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
delete() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Used to delete the CentraSiteObject being used from the underlying registry.
DeleteAction - Interface in com.softwareag.centrasite.api.csom.action
The DeleteAction interface facilitates to permanently delete the given object from CentraSite registry.
DeleteNotificationAction - Interface in com.softwareag.centrasite.api.csom.action
This action provides the capability to remove the notifications for one or more assets in the inbox.
deleteObjects(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Delete the registry objects associated with the corresponding the CentraSiteObject
deleteSavedSearch(CSOSearch) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Deletes a given saved search.
deleteSavedSearches(Collection<CSOSearch>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Deletes the given collection of saved searches.
DIAGNOSTIC_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent diagnositc implementation class.
DiagnosticConstants - Interface in com.softwareag.centrasite.api.diagnostic
DiagnosticConstants interface includes diagnostic constants that act as identifying tokens
DiagnosticContext - Class in com.softwareag.centrasite.api.diagnostic
DiagnosticContext class generates the diagnostics context object, wherein the context object is used in the sendDiagnostics call to replace an email template token.
DiagnosticContext(CLLException, CentraSiteConnection, Properties) - Constructor for class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
 
DiagnosticContext(CLLException, CentraSiteConnection, RegistryObject, Properties) - Constructor for class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
 
DiagnosticHandler - Interface in com.softwareag.centrasite.api.diagnostic
 
DownloadDocumentAction - Interface in com.softwareag.centrasite.api.csom.action
The DownloadDocumentAction provides the capability to download the documents associated with CentraSiteObject .

E

EditAction - Interface in com.softwareag.centrasite.api.csom.action
The EditAction interface provides a mechanism to modify the CentraSiteRegistryObject.
EMAIL_TEMPLATE_WEBDAV_LOCATION - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
enableAll() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
Enables all the ActivityMenuItems existed for the User.
ENDPOINT - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
ENTITY_PROD_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.UserRegistrationEmailConstants
 
ENTITY_REASON - Static variable in interface com.softwareag.centrasite.api.common.constants.UserRegistrationEmailConstants
 
ENTITY_USER_EMAIL - Static variable in interface com.softwareag.centrasite.api.common.constants.UserRegistrationEmailConstants
 
ENTITY_USER_FIRSTNAME - Static variable in interface com.softwareag.centrasite.api.common.constants.UserRegistrationEmailConstants
 
ENTITY_USER_LASTNAME - Static variable in interface com.softwareag.centrasite.api.common.constants.UserRegistrationEmailConstants
 
equals(Object) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
Compares the instances of CentraSiteObjectType instances with id.
Everything - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
 
execute() - Method in interface com.softwareag.centrasite.api.activity.Activity
 
execute() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Executes the search based on the given condition and scope
executeNextStep() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Executes the next step of this action.
executePreviousStep() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Executes the previous step of this action(roll back from current state).
exists() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryObject
 
ExportAction - Interface in com.softwareag.centrasite.api.csom.action
Export Action provides the ability to export CSROs into an export archive which could be imported into another CentraSite.
ExportOption - Enum in com.softwareag.centrasite.api.csom.action
The ExportOption serves an enhancement to the existing export function.
EXTERNAL_OBJECT - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
ExternalObject - Interface in com.softwareag.centrasite.api.csom.repository
ExternalObjects are CentraSiteFiles that reside at any location other than CentraSite Repository

F

FILE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
FileAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
FileAttribute interface represents the file based on attributes of a CentraSiteObject.
finishAllSteps() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Executes the remaining steps of this action.

G

getAboutTopics(ClientAboutInfo) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
 
getAction() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
Returns the corrective actions on occurrence of a particular exception with the given message Id.
getAction() - Method in class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
 
getAction(String) - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
Returns the CSOAction for the specified action Id.
getActionManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the action manager associated with this session.
getActivity(String) - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
Get the activity for the given activity identifier.
getActivity() - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
Get the activity referenced by the activity.
getActivityItems() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
Get the filtered activity items by applying filters.
getActivityManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the activity manager associated with this session.
getActivityManager(User) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the activity manager for the given user.
getActivityMenu() - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
Get the ActivityMenu associated with the ActivityManager.
getAdministrator() - Method in interface com.softwareag.centrasite.api.csom.Organization
Get the Administrator user for the current Organization
getAllActivities() - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
Get all the activities available in the configuration file.
getAllCommonAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
Returns all the Common Attributes.
getAllItems() - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Gets all Configuration items
getAllOrganization() - Method in interface com.softwareag.centrasite.api.csom.action.EditAction
Get complete list of registered organizations in CentraSite.
getAllowedNextStates() - Method in interface com.softwareag.centrasite.api.csom.LCMState
The next applicable state of registry object LCM ------------------------------------------------------------- | | | A --> B --> C --> D | | initial End | | | ------------------------------------------------------------- The above lcm model contains the states called A,B,C,D if the current state is B next allowed states are C
getAllowedPreferredNextState() - Method in interface com.softwareag.centrasite.api.csom.LCMState
The next preferred state for the registry object.
getAllStates() - Method in interface com.softwareag.centrasite.api.csom.LCM
Return all the state exists in the LCM.
getAllUsersAndGroups() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
 
getApplicableExportOptions() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
return available export options based on the objects set for the export action.
getApplicableLists() - Method in interface com.softwareag.centrasite.api.csom.action.RemoveFromListAction
Returns the user-specific "lists" that contain at least one selected CentraSite object.
getApplicableOrganizations() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Returns a list of organizations for which the user has Create Asset permission.
getApplicableOrganizations() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns the applicable organization for the action.
getApplicableReports() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Returns the collection of all applicable reports.
getApprovalRequestReason() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Get the reason for approval request if action is triggered for pending approval.
getApprovalRequestReason() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Get the reason for approval request if action is triggered for pending approval.
getApprovalWorkflowName() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Get the approval workflow name if action is triggered for pending approval.
getApprovalWorkflowName() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Get the approval workflow name if action is triggered for pending approval.
getApproveComments() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Get the comments for approving a request.
getAreaCode() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Gets the area code part of the Area Number
getAssets() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Returns a list of newly created assets.
getAssetTypes() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Returns the collection of top-level asset types
getAttachment() - Method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
Returns the attachment of diagnostics context.
getAttribute() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Returns the CSOAttribute addressed by the condition.
getAttribute(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns the CSOAttributes based on their (schema) name.
getAttribute(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves the specified attribute of the object type.
getAttributeLink(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the link associated with the attribute
getAttributeNames() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves all the attribute names of the object type.
getAttributes() - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
getAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns the Collection of CSOAttributes for the current scope.
getAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves all the attributes of the object type.
getAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
Get a list of attributes associated with the computed profile
getAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CSROProfile
Get the list of attributes that are associated with this profile
getAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
Get the list of attributes that are associated with this profile
getAttributeValue(String) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
Gets the value for the attribute
getAttributeValue(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the value for the attribute identified by the given name
getAttributeValue(QName) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the value for the attribute identified by the given QName(Qualified Name)
getAttributeValue(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the attribute value for the given attribute
getAvailableDateFormats() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the collection of available date formats as String.
getAvailableDisplayLanguages() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the list of available display languages sorted by name.
getAvailableLocales() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the list of available locales sorted by name.
getAvailableTimeFormats() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the collection of available time formats as String.
getAvailableTimezones() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the collection of available time zones.
getAvatar() - Method in interface com.softwareag.centrasite.api.csom.User
Get the profile picture's URL of the current user.
getBaseType() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
Retrieves the base type of the given type.
getBulkActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
Returns the list of CSOAction(s) that can be executed on a collection of CentraSiteObject(s).
getCanonicalPath() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets the canonical path representation for this Category.
getCentraSiteObjectConditionManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the condition manager associated with this session.
getCentraSiteObjectManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the object manager associated with this session.
getCentraSiteObjectSearchManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the search manager associated with this session.
getCentraSiteObjectType() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
getCentraSiteObjectTypeManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the type manager associated with this session.
getChangeLog() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns the change log parameter.
getCharsetName() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Gets the canonical name for the charset for this object
getChildCategories() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets all immediate children Categories.
getChildCategories() - Method in interface com.softwareag.centrasite.api.csom.Taxonomy
Gets all Children Categories.
getChildCategoryCount() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets number of children.
getChildCategoryCount() - Method in interface com.softwareag.centrasite.api.csom.Taxonomy
Gets number of children.
getChildOrganizationCount() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the count of child organization for the current organization
getChildOrganizations() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets all immediate children Organizations.
getCity() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress city
getClientAboutValues() - Method in interface com.softwareag.centrasite.api.about.ClientAboutInfo
Return the list of topic values for this client info
getClientRealDirLocation() - Method in interface com.softwareag.centrasite.api.about.ClientAboutInfo
Return the list of topic values for this client info will be rendered only for WebDir
getClientTopicsForAdmin() - Method in interface com.softwareag.centrasite.api.about.ClientAboutInfo
Return the list of admin topics for this client info
getCommonAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Returns the list of common attributes that are configured in System configuration.
getCondition() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
provides the problematic CSOSearchCondition object if present, else returns null.
getConditions() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the search conditions attached with the search object
getConfigurator() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Returns the default System Configurator
getConfigurator(User) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the user specific configurator.
getConfigurator(Organization) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the organization specific configurator.
getConnection() - Method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
Returns the logged in connection object.
getConsumerApplications() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
 
getConsumerRegistrationRequestor() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Get the user who requested a consumer registration if action is triggered.
getConsumerRegistrationRequestor() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Get the user who requested a consumer registration if action is triggered.
getConsumers() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
gets the users who are registered as Consumers for this CentraSiteRegistryObject
getContentType() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
content type of repository file
getContentURL() - Method in interface com.softwareag.centrasite.api.csom.HelpCenterTopic
Relative URL for the topic content; format of the content URL is /.html
getContext() - Method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
Returns the diagnostics context.
getCountry() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress country
getCountryCode() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Gets the country code part of the Telephone Number
getCurrentState() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Returns status of the document process.
getCurrentState() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the current state of this action.
getCurrentState() - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
currently assigned state of the registry object
getDataType() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns the data type of the CentraSite Object Attribute value is of.
getDefaultRepositoryFolder(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
return the DefaultRepositoryFolder based on the given CentraSiteObject.
getDefaultRepositoryFolder() - Method in interface com.softwareag.centrasite.api.csom.User
Get the repository location of the user.
getDefaultValue() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns the default value of the CentraSite Object Attribute, if present.
getDescendantCategories() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets all descendant Categories.
getDescendantCategories() - Method in interface com.softwareag.centrasite.api.csom.Taxonomy
Gets all descendant Categories.
getDescription() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the description of the CentraSite Object Attribute.
getDescription(Locale) - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the description of the CentraSite Object Attribute in the specified locale.
getDescription() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Get the description of the registry object.
getDescription(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Get the description of the registry object.
getDescription() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Returns the file description
getDiagnosticHandler() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Instantiate the DiagnosticHandler, which is used to notify the diagnostics to the user in case exception occurred during the execution..
getDiagnosticHandler() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the session diagnostic handler.
getDirection() - Method in enum com.softwareag.centrasite.api.csom.search.CSOSortSpecifier.Direction
 
getDisplayLanguage() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
 
getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the display name of the CentraSite Object Attribute in the current user's locale.
getDisplayName(Locale) - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the display name of the CentraSite Object Attribute in the specified locale.
getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
 
getDisplayName(Locale) - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
 
getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Retrieves the display name of the condition
getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Retrieves the dsiplay name of the scope according to the user locale.
getDisplayName(Locale) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Retrieves the display name of the type according to the given locale.
getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.User
Returns the Display Name of the current user.
getDisplayURI() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
return the uri which used to display to the user.
getDisplayVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the display version of a CentraSiteRegistryObject.
getDownloadContent() - Method in interface com.softwareag.centrasite.api.csom.action.DownloadDocumentAction
Returns the binary download content for the zip file containing the CentraSiteRegistryObject documents as InputStream.
getEffectiveSearchScopes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the consolidated collection of search scopes based on the specified scopes The consolidation will be done based on whether a particular scope is a subset of another scope For example, If 'Everything' scope and 'User' scope are specified as scope, the effective scope would be only 'Everything', since User is a subset of Everything
getEmailAddresses() - Method in interface com.softwareag.centrasite.api.csom.Organization
Get the Email Address of the current Organization
getEmailAddresses() - Method in interface com.softwareag.centrasite.api.csom.User
Get the collection of email addresses for the current user.
getEnumValues() - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Get enumerated values (i.e., list of possible values) for an attribute of "string" data type.
getExcludedCategories() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns a collection of categories that are excluded from the search scope.
getExistingAssets() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Returns existing dependent assets for the specified asset's document.
getExistingLists() - Method in interface com.softwareag.centrasite.api.csom.action.AddToListAction
 
getExplanation() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
Returns the explanation of an exception message with the given message Id.
getExplanation() - Method in class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
 
getExportArchive() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Get the export archive content as stream.
getExportLogMessages() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Get the logs for the export.
getExportOption() - Method in enum com.softwareag.centrasite.api.csom.action.ExportOption
 
getExportPreview() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Returns the preview of the export in the form of a map.
getExtension() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Gets the extension code part of the Telephone Number
getFileName() - Method in interface com.softwareag.centrasite.api.csom.action.DownloadDocumentAction
Returns the zip file name for download
getFileName() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Returns the zip file name used to create the zip file
getFileName() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Return the file name
getFiles(String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Retrieve the files nested under the given base folder which matches the specified name pattern + ----------------- + | | | projects | + ----------------- + | + ----------------- + +-----------------+ | | | | | centrasite1 | - | centrasite3.txt | + ----------------- + +-----------------+ | + ----------------- + | | | centrasite2.txt | + ----------------- + in case of the above folder structure getFiles("/projects", "centrasite") return files /projects/centrasite1/centrasite3.txt and /projects/centrasite1/centrasite2.txt even though folder also contains the matching patterns it did not include in the result.
getFiles() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFolder
Return the files nested directly under this folder
getFirstName() - Method in interface com.softwareag.centrasite.api.csom.User
Get First Name of the current user.
getFolders(String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Retrieve the folders nested under the given base folder and matching the specified name pattern + ----------------- + | | | projects | + ----------------- + | + ----------------- + +-----------------+ | | | | | centrasite1 | - | centrasite3.txt | + ----------------- + +-----------------+ | + ----------------- + | | | centrasite2.txt | + ----------------- + in case of the above folder structure getFolders("/projects", "centrasite") return files /projects/centrasite1 even though files contain the matching patterns it did not include.
getFolders() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFolder
Return the folders nested directly under this folder
getGroup() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the group Id to which this action belongs.
getGuestUserLocale() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
this method return the guest user locale
getHelpCenter() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Return the HelpCenter which is used to access the available HelpCenterTopic's
getIconURL() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the URL of the icon defined for this action.
getIconURL() - Method in interface com.softwareag.centrasite.api.csom.HelpCenterTopic
Relative URL for the icon; format of the icon URL is .png
getId() - Method in interface com.softwareag.centrasite.api.about.AboutTopic
Return the identifier for this topic
getId() - Method in interface com.softwareag.centrasite.api.about.AboutTopicValue
Return the identifier for this topic value
getId() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the Id of this action.
getId() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the Unique Identifier for the object.
getId() - Method in interface com.softwareag.centrasite.api.csom.HelpCenterTopic
An unique identifier of the topic.
getInboxActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
Returns a list of "Inbox" specific actions.
getIncludedCategories() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns a collection of categories that are included in the search scope.
getInfoType() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
validation Info Type which helps to understand the level of the validation error i.e ERROR, WARNING
getInitialState() - Method in interface com.softwareag.centrasite.api.csom.LCM
Initial state of LCM.
getInputStream() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Get the file content as input stream
getInstance() - Static method in class com.softwareag.centrasite.api.service.CentraSiteServiceFactory
 
getItemAttribute(String, String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Get attribute value of given path.
getItems(String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Get ConfiguratorItems for given path
getItems(List<String>) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Get ConfiguratorItems for given list of paths
getItemValue(String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Get item value of given path.
getKey() - Method in interface com.softwareag.centrasite.api.about.AboutTopicValue
Return the localized name for this topic value
getLastName() - Method in interface com.softwareag.centrasite.api.csom.User
Get Last Name of the current user.
getLCM() - Method in interface com.softwareag.centrasite.api.csom.LCMState
return LCM to which the state belongs.
getLCMAssignment() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Return the lifecycle state information of the CSRO
getLCMStateById(String) - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
 
getLocale() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Get the Locale for this object.
getLocalizedString(Locale, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Gets the CentraSiteLocalizedString for the specified Locale and charsetName.
getLocalizedStrings() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Returns the CSOLocalizedStrings associated with this object.
getLocalName() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
fetch Local-Name Classification of this RegistryObject.
getLocalStringValue(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Gets the String value for the specified Locale.
getMandatoryAttributeProfiles() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Return the list of profiles for the CSRO in which there is atleast one mandatory attribute, ordered by the profile sequence number.
getMandatoryAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
Return the list of mandatory attributes for this profile.
getMatchAnySpecifier() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the value of the match-any specifier
getMessage() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.
getMessage() - Method in class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
 
getMessage() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
If the AttachDocumentProcessor fails to process the document, this returns the root cause message.
getMessage() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
the detailed message describes about the the validation error.
getMessageID() - Method in class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
 
getMessageID() - Method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
 
getMessageObject() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
 
getMessages(I18NMessageEnum, String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getMessageWithParameters(I18NMessageEnum, String, Object[], String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getMessageWithParameters(String, Object[]) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
Returns the I18N message formatted with specified parameters.
getMessageWithParameters(String, Object[], String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getMiddleName() - Method in interface com.softwareag.centrasite.api.csom.User
Get Middle Name of the current user.
getMissingFileName() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Returns the missing file name to be uploaded by the user.
getName() - Method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
 
getName() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the name of this action.
getName() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the name of the CentraSite Object Attribute.
getName() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Get the Name of the CentraSiteRegistryObject
getName(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Get the Name of the CentraSiteRegistryObject for the given locale
getName() - Method in interface com.softwareag.centrasite.api.csom.HelpCenterTopic
Name of the topic.
getName() - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
return the LCMState label, in case the next state transition is in pending the label is enclosed with Pending i.e Pending(State)
getName(Locale) - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
return LCMStateAssignment.getName() specific to given locale.
getName() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Return the file or folder name
getName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
 
getName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Retrieve the name given for saving the search.
getName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Retrieves the name of the condition.
getName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Retrieves the name of the scope.
getNamespace() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns the namespace parameter from the action.
getNameSpace() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
fetch namespace Classification of this RegistryObject.
getNestedProfiles() - Method in interface com.softwareag.centrasite.api.csom.type.CSROProfile
Get the list of profiles that are nested under this profile
getNestedProfiles() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
Get the list of profiles that are nested under this profile
getNewAssetId() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Return the newly created asset.
getNewVersionObjects() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
returns the collection of newly versioned objects, null incase version action is not executed successfully.
getNextVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the CentraSiteRegistryObject representing the next version.
getNextVersions() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the List of CentraSiteRegistryObject representing the next versions.
getNotificationSettings() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Return the notification settings of logged in user.
getNumber() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Gets the Number part of the Telephone Number
getObject(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Populate the CentraSiteRegistryObject persisted using the given Unique Id.
getObjects(List<String>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Populate the list of CentraSiteObjects persisted using the given identifiers.
getOperator() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Returns the condition operator.
getOperator() - Method in enum com.softwareag.centrasite.api.csom.search.Operator
 
getOptionsForAsset(CentraSiteRegistryObjectType) - Static method in enum com.softwareag.centrasite.api.csom.action.AssetSupportedOption
 
getOrganization() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the Organization of the CentraSiteRegistryObject
getOrganization() - Method in interface com.softwareag.centrasite.api.csom.LCM
Get the Organization LCM is applicable.
getOrganizations() - Method in interface com.softwareag.centrasite.api.csom.User
Get all organizations this user belongs to.
getOwner() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the owner of the CentraSiteRegistryObject
getOwner() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the owner of this session.
getOwnerLocale() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the locale defined for the currently logged in user.
getParameters() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Return the collection of CSOParameter which need to be set for the predefined report search to execute
getParameterTokens() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Return the collection of parameter tokens which need to be set for the predefined search to execute
getParent() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets the parent Category or Taxonomy for this object.
getParentOrganization() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the parent (container) organization.
getPath() - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
getPathObjects() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets easy access to the categories/taxonomy that are on the path from a given category to the root of the taxonomy.
getPendingState() - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
Pending state of the registry object in case that state is exists other wise return null.
getPhoneType() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Get the phone type
getPhoneTypeCategories() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Returns the collection of phone type taxonomy categories.
getPostalAddress() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the PostalAddress for this User
getPostalAddress() - Method in interface com.softwareag.centrasite.api.csom.User
Get the Postal Addresses for the user.
getPostalCode() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress postal code
getPostLoginKeys() - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getPostloginLocaleMessages(String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getPrecision() - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Gets the precision value for an attribute of "number" data type.
getPredicate() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Returns a String holding the query fragment representing the condition.
getPreferredDateFormat() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the preferred date format as String.
getPreferredDisplayLanguage() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the preferred display language.
getPreferredLocale() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the preferred locale.
getPreferredTimeFormat() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the preferred time format as String.
getPreferredTimezone() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Get the preferred time zone.
getPreLoginKeys() - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getPreloginLocaleMessages() - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getPreloginLocaleMessages(String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
 
getPreviousVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the CentraSiteRegistryObject representing the previous version.
getPreviousVersions() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the List of CentraSiteRegistryObject representing the previous versions.
getPrimaryContact() - Method in interface com.softwareag.centrasite.api.csom.Organization
Get the primary contact User for the current Organization
getPrimaryProfiles() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
Retrieves the list of Profiles that are associated with this CentraSiteRegistryObjectType
getPrivilege() - Method in interface com.softwareag.centrasite.api.csom.ACL
 
getProcessedObjectsCount() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Get the number of processed in the process of exported action(i.e this count is cumulative of exported successfully, exported with warnings, export failed objects count )
getProfileId() - Method in interface com.softwareag.centrasite.api.csom.type.CSROProfile
Get the profile id.
getProfileId() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
Get the profile id.
getQName() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Retrieves the fully qualified name of the CentraSite Object Attribute.
getQName() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves the fully qualified (schema) name of the type
getQualifiedAttributeNames() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves all the qualified names for attributes of the object type.
getRegistryObject() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
 
getRejectComments() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Get the comments for rejecting a request.
getRelationShipType() - Method in interface com.softwareag.centrasite.api.csom.attribute.RelationShipAttribute
Returns the category of the relationship attribute.
getReportFormat() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Returns the report format.
getReportingSearches() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Fetches the collection of saved searches that are marked as report search
getReportURL() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Returns the report URL.
getResource() - Method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
 
getResultAttribute() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
provides the problematic CentraSiteObjectAttribute if present in the result attributes, else return null.
getResultAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the search attributes which is configured already with the search
getResultAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchResult
Returns the result attributes which is configured with the search object already
getRootOrganziation() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the root organization.
getSavedSearches(User) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Loads the collection of saved searches for a given user.
getSavedSearches(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Loads the collection of saved searches according to the given name.
getSchemaName() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
Retrieves the (schema) name of the type.
getScope() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
provides the problematic CSOSearchScope in the search if present, else returns null.
getSearchConditionManager() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Returns the search condition manager which will be used to create a search condition.
getSearchScope() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Deprecated. This method will be removed soon. Please use getSearchScopes()
getSearchScopes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the collection of specified search scopes
getSearchScopes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Returns the collection of configured search scopes
getSelectedOrganization() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns the organizatin parameter of the action.
getSelectedReport() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Returns the selected report.
getServices() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets all children Services for the current Organization
getSingleObjectActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
Returns the list of CSOAction(s) that can only be executed on a single CentraSiteObject(s).
getSingleObjectActions(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
Returns the list of CSOAction(s) that are allowed for the given object.
getSkippedObjectsWithReason() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Gets the skipped objects with the reason to be skipped.
getSortAttribute() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSortSpecifier
Returns the sort attribute.
getSortDirection() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSortSpecifier
Gets the direction of the sort specifier
getSortSpecifier() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Assigns sort specifier to the CSOSearch
getSortSpecifier() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
provides the problematic CSOSortSpecifier else return null.
getStackTrace(Throwable) - Static method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
 
getStateOrProvince() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress state province
getStreet() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress Street
getStreetNumber() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress street number
getSubscribers() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
gets the users who have subscribed to (or watching) this CentraSiteRegistryObject for notifications
getSupportedOptions() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Returns a collection of AssetSupportedOption
getSystemVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the system version of the CentraSiteRegistryObject
getTargetObjectTypes() - Method in interface com.softwareag.centrasite.api.csom.attribute.RelationShipAttribute
Returns the collection of CentraSiteRegistryObjectType.
getTaxonomy() - Method in interface com.softwareag.centrasite.api.csom.attribute.ClassificationAttribute
Retrieves a taxonomy object that is defined as part of the classification attribute.
getTaxonomy() - Method in interface com.softwareag.centrasite.api.csom.attribute.CSOComputedAttribute
Retrieves a taxonomy object that is defined as part of the computed attribute.
getTaxonomy() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets the Taxonomy that this Category is a descendant of.
getTelephoneNumbers(String) - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the telephone numbers for this User that match the specified telephone number type.
getTelephoneNumbers(String) - Method in interface com.softwareag.centrasite.api.csom.User
Get the collection of telephone numbers for the current user.
getTitle() - Method in interface com.softwareag.centrasite.api.about.AboutTopic
Return the title of this topic
getTopicInfo() - Method in interface com.softwareag.centrasite.api.about.AboutTopic
Return the list of values under this topic
getTopics() - Method in interface com.softwareag.centrasite.api.csom.HelpCenter
Lists the topics that provide specific information about the product as a HelpCenter.
getTotalObjectsCount() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
total number of objects identified for export(i.e this count is cumulative of top level objects and it dependent objects also)
getTransformedContent() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Get the webdav content as InputStream
getTransformedContent(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Get the webdav content as InputStream
getType() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns the type of the CentraSite Object Attribute.
getType() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Get the type of the CentraSiteObject instance.
getType() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Returns the PostalAddress type
getType() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
 
getType() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Returns the type of search {Reporting/Normal/Parameterized}
getType(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
populate the CentraSiteRegistryObjectType , if the concept is exists with the given name.
getType(QName) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
populate the CentraSiteObjectType persisted using the given primary key.
getTypeByDisplayName(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
create the CentraSiteObjectType for the given name.
getTypes() - Method in interface com.softwareag.centrasite.api.csom.LCM
Return the types applicable for the current LCM.
getTypes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns the asset types which is attached with the search scope Inbox/Everything search scopes will have more than one types
getTypes(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
fetches the collection of types that are containing the given keyword
getUnitLabel() - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Returns the slot's unit label.
getURI() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Returns the URI where the file is stored
getURI() - Method in interface com.softwareag.centrasite.api.csom.search.CSOLink
Returns a URI based on the link type and link parameters
getURI(CSOLink) - Method in interface com.softwareag.centrasite.api.session.CSOUriGenerator
Generates a link for the given CSOLink object.
getURIGenerator() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Returns the CSOUriGenerator for this session.
getURL() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
Returns the authenticated webdav URL of the computed profile module
getUserPreferences() - Method in interface com.softwareag.centrasite.api.csom.User
Return UserPreferences of this user.
getUsers() - Method in interface com.softwareag.centrasite.api.csom.Organization
Gets the Collection of Users affiliated with this Organization
getUserSelectedExportOptions() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Get the collection of export options relevant for the objects specified in setObjects().
getUserVersion() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns the user version parameter
getUserVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Retrieves the user version of the CentraSiteRegistryObject
getValue() - Method in interface com.softwareag.centrasite.api.about.AboutTopicValue
Return the actual value
getValue() - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
getValue() - Method in enum com.softwareag.centrasite.api.csom.action.ActionStateEnum
 
getValue() - Method in enum com.softwareag.centrasite.api.csom.action.ReportFormats
 
getValue() - Method in interface com.softwareag.centrasite.api.csom.Category
Gets the value (usually a code in a taxonomy) associated with this Category.
getValue() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Gets the String value for the user locale.
getValue(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Gets the String value for the specified Locale.
getValue() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Get the String value for this object.
getValue() - Method in enum com.softwareag.centrasite.api.csom.NotificationOption
 
getValue() - Method in enum com.softwareag.centrasite.api.csom.search.validation.ValidationInfoType
 
getValues() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Returns the parameters of the condition.
getVisiblePrimaryProfiles() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
get the list of primary Profiles including inherited profiles in case of Virtual Types based on the current user permission
getWebPage() - Method in interface com.softwareag.centrasite.api.csom.Organization
Get the webPageURL of current Organization.
GUEST_FALL_BACK_LOCALE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 

H

hashCode() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
 
HelpCenter - Interface in com.softwareag.centrasite.api.csom
CentraSite Help Center bundles access to CentraSite product information and also related information.
HelpCenterTopic - Interface in com.softwareag.centrasite.api.csom
The HelpCenterTopic interface provides information required to render the topic.

I

I18NMessageEnum - Enum in com.softwareag.centrasite.api.common.i18nresource
 
I18NMessageUtil - Class in com.softwareag.centrasite.api.common.i18nresource
Utility class for I18NMessage
ID - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
includeSupportingDocuments() - Method in interface com.softwareag.centrasite.api.csom.action.DownloadDocumentAction
Returns if the supporting documents associated with the CentraSiteRegistryObject can be included for download.
inheritsProfiles() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
Checks if current type inherits profiles from base type
INMCONF_FILE_PATH_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
isActive() - Method in interface com.softwareag.centrasite.api.csom.LCM
find weather given LCM is active or not
isActive() - Method in interface com.softwareag.centrasite.api.csom.User
Whether current user is active or inactive
isActiveSoaEdition() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Return whether the server has an ActiveSoaEdition license
isAllowed() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Verifies if the logged in user can execute this action on a collection of CentraSiteObject(s).
isApplicable(User) - Method in interface com.softwareag.centrasite.api.activity.Activity
indicates whether this activity is applicable for the given user.
isApplicable() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Verifies if the action can be applied on the specified collection of CentraSiteObject(s).
isCentraSiteAdministrator() - Method in interface com.softwareag.centrasite.api.csom.User
Checks whether this user has CSA role.
isClosed() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
Indicates whether the current session is active or inactive.
isComputed() - Method in interface com.softwareag.centrasite.api.csom.type.CSROProfile
Checks if a this profile is a computed profile
isComputed() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
Checks if a this profile is a computed profile
isEnabled() - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
Get information about whether this menu item is visible or not
isExpandable() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Returns whether this scope is expandable or not.
isExternal() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Checks whether the file is stored in repository or otherwise
isExternal() - Method in interface com.softwareag.centrasite.api.csom.Taxonomy
Determines whether this ClassificationScheme is an external ClassificationScheme or an internal ClassificationScheme.
isFolder() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryObject
 
isGlobal() - Method in interface com.softwareag.centrasite.api.csom.LCM
find weather LCM is applicable for multiple organizations.
isGuest() - Method in interface com.softwareag.centrasite.api.csom.User
Check if the user is a guest.
isLatestVersionObject() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Checks if current object is the maximum (or only) version object
true: is the maximum (or only) version object
false: its an intermediate version object
isModified() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Indicates whether current object being used have modifications compare to the same persisted instance.
isMultiValued() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns a boolean value to determine if the CentraSite Object Attribute is multi-valued or not.
isMultiValued() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
 
isNumberSeparatorEnabled() - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Check if the number separator is enabled or disabled.
isPending() - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
used to find the registry object is pending state.
isPendingApproval() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Check if action is triggered for pending approval.
isPendingApproval() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Check if action is triggered for pending approval.
isPendingConsumerRegistration() - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Check if action is triggered for pending consumer registration.
isPendingConsumerRegistration() - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Check if action is triggered for pending consumer registration.
isPrefix() - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Returns if the slot's unit label is a prefix or suffix value.
isPreviewComplete() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
 
isPropagateVersion() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Returns whether propagate version to dependent object is set or not.
isProtected() - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
isReadOnly(String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Checks whether its read only
isReadOnly() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns a boolean value to determine if the CentraSite Object Attribute is read-only or not.
isReadOnly() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Indicates whether current object being used is write protected or not for the caller.
isRequired() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
Returns a boolean value to determine if the CentraSite Object Attribute requires a value or not.
isSearchKeyExists(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Checks whether a search with given name already exists.
isVersionable() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
Checks if the instances of the type can be version
iterator() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchResult
Returns the iterator which will be used to fetch the search result Will give the cursor which will be enabled with on-demand load functionality

J

JAXR_CONN_FACTORY_IMPL_CLASS - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
CentraSite JAXR connection factory value
JRE_VERSION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 

K

KEY - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
KeywordCondition - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Used to mark the condition to be a keyword condition

L

LCM - Interface in com.softwareag.centrasite.api.csom
LCM is a state machine which contains a set of states and LCM is applicable to a set of CentraSiteObjecType's.
LCModel - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOParameterType
 
LCMState - Interface in com.softwareag.centrasite.api.csom
LCMState is the state in the LCM state machine.
LCMStateAssignment - Interface in com.softwareag.centrasite.api.csom
LCMStateAssignment wraps the current state and pending of the CentraSiteObject.
loadSearch(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Creates a CSOSearch object from the given predefined search name.loadSearch() would pick up the saved search in a hierarchical fashion - starting with user-specific folder, then org-level and then the global (default org)
lookup(int) - Static method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
 
lookup(String) - Static method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
 
lookUp(String) - Static method in enum com.softwareag.centrasite.api.csom.action.ExportOption
 
lookup(String) - Static method in enum com.softwareag.centrasite.api.csom.search.CSOSortSpecifier.Direction
 
lookup(String) - Static method in enum com.softwareag.centrasite.api.csom.search.Operator
 
lookup(String) - Static method in enum com.softwareag.centrasite.api.csom.search.validation.ValidationInfoType
 

M

MY_INBOX - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
MY_LIST - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 
MY_SAVED_SEARCHES - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
 

N

NAME_SPACE_PROTOCOLS - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
NEW_LINE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
NewVersionAction - Interface in com.softwareag.centrasite.api.csom.action
NewVersionAction creates a new version of a CentraSiteRegistryObject.
NotificationOption - Enum in com.softwareag.centrasite.api.csom
Enumeration class for notification options that are being used in UserPreferences.

O

OBJECT_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
OBJECT_TYPE_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
OPERATION_SLOT_HTTPMETHODS_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
Operator - Enum in com.softwareag.centrasite.api.csom.search
Operator specifies the operator of the condition
Organization - Interface in com.softwareag.centrasite.api.csom
CSOM Organization Common interface for organization related information.
Organizations - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
 
OS_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
OS_VERSION - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 

P

PASSWORD_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key for retrieving passsword
PATH_BOTTOM_BACKGROUND_IMAGE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_BOTTOM_BACKGROUND_IMAGE_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_BOTTOM_COPY_RIGHT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_BOTTOM_POWERED_BY - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_BOTTOM_POWERED_BY_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_BOTTOM_TIME_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_COMPANY_LOGO - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_COMPANY_LOGO - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_COMPANY_LOGO_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_GUEST - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_INTRODUCTION_IMAGE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_INTRODUCTION_IMAGE_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_INTRODUCTION_PANE_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_INTRODUCTION_TEXT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_INTRODUCTION_TEXT_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_LINK_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_PAGE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_REMEMBER_ME - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_SOURCE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_LOGIN_TYPE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_PRODUCT_NAME - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REASON_FOR_REQUEST_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_ADMIN_EMAIL_TEMPLATE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_COMPANY_LOGO - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_COMPANY_LOGO_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_COPYRIGHT_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE_ADMIN_EMAIL - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE_ADMINSUBJECT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE_EMAILATTRIBUTE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE_PATH - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_EMAIL_TEMPLATE_USERSUBJECT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_INTRO_PANE_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_INTRODUCTION_IMAGE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_INTRODUCTION_IMAGE_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_INTRODUCTION_TEXT - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_INTRODUCTION_TEXT_VISIBLE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_SOURCE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_REQUEST_AN_ACCOUNT_USER_EMAIL_TEMPLATE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_USER_LANGUAGE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_USER_LOCALE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_USER_REGISTRATION_ADMIN_EMAIL_TEMPLATE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PATH_USER_REGISTRATION_USER_EMAIL_TEMPLATE - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
PostalAddress - Class in com.softwareag.centrasite.api.csom
Bean class which represents Postal Address
PostalAddress() - Constructor for class com.softwareag.centrasite.api.csom.PostalAddress
 
PredefinedSearches - Interface in com.softwareag.centrasite.api.csom.search
Predefined search names.
PRODUCT_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
Profile - Interface in com.softwareag.centrasite.api.csom.type
The Profile object is a logical wrapper to represent the CentraSiteObjectAttributes detail of a CentraSiteRegistryObject CentraSiteRegistryObjectType.getProfiles would return a list of Profiles associated with the CentraSiteRegistryObjectType CentraSiteRegistryObject.getProfiles methods can be used to obtain the associated profiles at instance level
PROFILE_ID_AdvancedInformation - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
PROFILE_ID_BasicInformation - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
purgeVersions(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Purges the previous versions of the given object.

Q

QNAME_COMMON_ATTRIBUTE_CONSUMERS - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_CREATION_DATE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_DESCRIPTION - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_KEY - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_MODIFIED_DATE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_NAME - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_OWNER - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_STATE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_SUBMITTING_ORGANIZATION - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_SUBSCRIBERS - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_TYPE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_COMMON_ATTRIBUTE_VERSION - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CommonAttribute
 
QNAME_ENDPOINT - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
QNAME_LOCAL_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
QNAME_NAME_SPACE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
QUERY_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
QUERY_MANAGER_URL_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent the CentraSite query manager URL.

R

REASON_FOR_REQ_ACCOUNT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
RejectAction - Interface in com.softwareag.centrasite.api.csom.action
The RejectAction interface contains various methods that enable defining and retrieving comments for rejecting a request.
RELATIONSHIP - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
 
RelationShipAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
RelationShipAttribute interface represents the relationship based on attribute of a CentraSiteObject.
reload() - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Clears the caches and reloads all the properties from repository
reload(List<ConfiguratorItem>) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Clears the specified configuration items from the cache
removeActivity(String) - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
Remove the activity associated with the given activity identifier.
removeAttribute(String) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
removeExportOptions(Collection<ExportOption>) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Remove the options for export
RemoveFromListAction - Interface in com.softwareag.centrasite.api.csom.action
The RemoveFromListAction interface provides the facility to remove one or more CSROs from the selected list(s).
removeItem(ConfiguratorItem) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
 
removeItems(String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
 
removeLocalizedString(CentraSiteLocalizedString) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Removes a LocalizedString from this object.
removeLocalizedStrings(Collection<CentraSiteLocalizedString>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Removes specified LocalizedStrings to this object.
removeResultAttribute(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Removes the specified CentraSiteObjectAttribute from the search
removeSearchCondition(CSOSearchCondition) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Removes the specified condition from the search
removeSearchScope(CSOSearchScope) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Removes the specified scope from the search
removeSortSpecifier(CSOSortSpecifier) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Removes the specified CSOSortSpecifier from the search.
ReportAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
Marker interface defining the attributes in a report.
ReportFormats - Enum in com.softwareag.centrasite.api.csom.action
 
REQUEST_ACCOUNT_SUCCESS_MSG - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Success message sent to the caller if the 'RequestAccount' is successful.
requestAccount(Map<Object, Object>) - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
Request for a new CentraSite account.
RevertAction - Interface in com.softwareag.centrasite.api.csom.action
The RevertAction interface provides a mechanism to revert an approval request.

S

save() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
Saves the activities menu items belongs to the activity menu.
save() - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Saves the modified configuration files
save() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Used to persist the CentraSiteObject to the underlying registry.
SaveAction - Interface in com.softwareag.centrasite.api.csom.action
The SaveAction interface facilitates to update an object in the CentraSite registry.
saveObjects(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
Persists the given list of CentraSiteObject
saveSearch(CSOSearch) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Saves the given search with the specified name i.e CSOSearch.getName() in case of search already exists with the given name then treat this operation as Update.
saveSearch(CSOSearch, boolean) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
Saves the given search with the specified name i.e CSOSearch.getName() in case of search already exists with the given name then treat this operation as Update when overwrite flag is set otherwise reject the save
SEARCH_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
sendDiagnostics(DiagnosticContext) - Method in interface com.softwareag.centrasite.api.diagnostic.DiagnosticHandler
This method send the diagnostic content to the configured email recipients
Service - Interface in com.softwareag.centrasite.api.csom
Service instances are CentraSiteRegistryObject that provide information on services (for example, web services) offered by an Organization.
SERVICE_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
setActivity(Activity) - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
 
setActivityItemList(List<ActivityMenuItem>) - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
Set the ActivityItems to the ActivityMenu.
setApproveComments(String) - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
Set the comments for approving a request.
setAreaCode(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Sets the area code part of the Area Number
setAssetName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the name for the asset.
setAttachment(String) - Method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
Sets attachment for each diagnostics context.
setAttribute(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Sets the CSOAttribute for the condition.
setAttributes(HashMap<String, String>) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
setAttributeValue(String, String) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
setAttributeValue(String, Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Set the value for the attribute identified by the given name.
setAttributeValue(QName, Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Set the value for the attribute identified by the given QName(Qualified Name).
setAttributeValue(CentraSiteObjectAttribute, Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObject
Set the attribute value for the given attribute.
setAvatar(InputStream) - Method in interface com.softwareag.centrasite.api.csom.User
Upload the given image as the profile picture of the current user.
setChangeLog(String) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Sets the change log entry for he new version.
setCharsetName(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Set the canonical name for the charset for this object.
setCity(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Set the PostalAddress city
setConditions(Collection<CSOSearchCondition>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Attach the search condition with the search object
setCountry(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Set the PostalAddress country
setCountryCode(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Sets the country code part of the Telephone Number
setCreateNewAsset(boolean) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
creates the new asset instance based on the given inputs.
setCreateVersion(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
If createVersion is true, creates an asset with the next available version and given document.
setCredentials(PasswordAuthentication) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the credentials if in case of a need to protect documents.
setDescription(String) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Sets the description for the registry object that is being created as part of this activity
setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Set the description of the registry object for the current user locale.
setDescription(String, Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Set the description of the registry object.
setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Set the description for the file
setDisplayVersion(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Updates the user version according to the given parameter
setDocument(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the location of the document to the specified URI.
setDocument(InputStream) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the document content as InputStream.
setEmailAddresses(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.User
Sets the given collection of email addresses to the current user.
setEnabled(boolean) - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
 
setEnumValues(String[]) - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Sets enumeration values (i.e., list of possible values) for an attribute of "string" data type.
setExcludedCategories(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Sets the collection of categories which need to be excluded the search scope.
setExcludedObjects(Collection<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Specify the collection of object(s) which will be excluded from the export archive.
setExistingList(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.action.AddToListAction
Sets the objects to a given existing list.
setExtension(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Sets the extension code part of the Telephone Number
setFileName(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Sets the name of the file
setFirstName(String) - Method in interface com.softwareag.centrasite.api.csom.User
Sets First Name for the current user.
setHttpServletRequest(HttpServletRequest) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
 
setIncludedCategories(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
Sets the collection of categories which need to be included in the search scope.
setIncludeSupportingDocuments(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.DownloadDocumentAction
Allow or disallow supporting documents associated with the CentraSiteRegistryObject to be included or excluded for download.
setInputStream(InputStream) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
Specify the content for the file as input stream
setInteractiveResolution(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
if the set interactive resolution is true, then system won't interact with user in case missing document already exists.
setItems(List<ConfiguratorItem>) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Sets the given Configuration Items
setLastName(String) - Method in interface com.softwareag.centrasite.api.csom.User
Sets Last Name for the current user.
setLCMState(LCMState) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Allowed to set the LCMState to CentraSiteRegistryObject.
setLocale(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Set the Locale for this object.
setLocalName(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Set Local-Name Classification of this RegistryObject.
setMatchAnySpecifier(boolean) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Sets the match-any specifier
setMiddleName(String) - Method in interface com.softwareag.centrasite.api.csom.User
Sets Middle Name for the current user.
setName(String) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Sets the name for the registry object that is being created as part of this activity
setName(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Sets the Name to the CentraSiteRegistryObject for the current user locale.
setName(String, Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Set the name in the given locale.
setName(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Set the name of the file or folder name.
setName(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Set the given name to the search.
setNamespace(String) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Sets the namespace for the new version.
setNameSpace(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Set namespace Classification of this RegistryObject.
setNewListName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddToListAction
Sets the objects to a given new list.
setNotificationSettings(Collection<NotificationOption>) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the given notification settings to logged in user-specific configuration.
setNumber(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Gets the Number part of the Telephone Number
setNumberSeparator(boolean) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Enable or disable the number separator
setObjects(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
Sets the collection of CentraSiteObject(s) on which this
action can be executed.
setOperator(Operator) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Sets the condition operator from predefined enum.
setOperator(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Sets the condition operator from a string.
setOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
set the Organization of the CentraSiteRegistryObject
setOrigionalName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the display name for the attached main document.
setOverwriteExisting(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
If overwrite is true, overwrites the existing document attached to the asset.
setOwner(User) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
sets the owner of the CentraSiteRegistryObject
setParameter(String, List<Object>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Set the parameters for the predefined search.
setPhoneType(Category) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
Set the phone type
setPostalCode(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Set the PostalAddress postalCode
setPrecision(int) - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
Sets the precision for an attribute of "number" data type.
setPredicate(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Assigns a string holding the query fragment to the condition.
setPreferredDateFormat(String) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the preferred date format as String.
setPreferredDisplayLanguage(Locale) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the preferred display language.
setPreferredLocale(Locale) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the preferred locale.
setPreferredTimeFormat(String) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the preferred time format as String.
setPreferredTimezone(TimeZone) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
Set the preferred time zone as String.
setPreviewComplete(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
used to set to true in case of preview options is finalized.
setPrivilege(int) - Method in interface com.softwareag.centrasite.api.csom.ACL
 
setPropagateVersion(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Sets the "Propagate versions to dependent object" for creating the new version.
setProtectAll(boolean) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
Protects all properties
setProtected(boolean) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
setRejectComments(String) - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
Set the comments for rejecting a request.
setRemoveLists(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.RemoveFromListAction
Sets the "lists" from which the object(s) should be removed.
setReportFormat(ReportFormats) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Sets the report format.
setResultAttributes(Collection<CentraSiteObjectAttribute>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Sets the result attributes with the search object.
setReuseAsset(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
If a dependent asset exists, sets the user specified asset Id to attach to the asset.
setSearchScope(CSOSearchScope) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Deprecated. This method will be removed soon. Please use setSearchScopes()
setSearchScopes(List<CSOSearchScope>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Sets the collection of scopes for the search
setSelectedConsumerApplications(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
 
setSelectedOrganization(Organization) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Sets the selected organization for the registry object that is being created as part of this activity
setSelectedOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Sets the organization for the new parameter
setSelectedReport(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
Sets the selected report.
setSelectedType(CentraSiteRegistryObjectType) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Sets the selected asset type for the registry object that is being created as part of this activity
setSelectedUsersAndGroups(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
 
setSortAttribute(CentraSiteObjectAttribute) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSortSpecifier
Add an attribute for further filtering of the sort specifier.
setSortDirection(CSOSortSpecifier.Direction) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSortSpecifier
Sets the direction of the sort specifier
setSortSpecifier(List<CSOSortSpecifier>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Assigns sort specifier to the CSOSearch.
setStateOrProvince(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Sets the PostalAddress state province
setStreet(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Sets the PostalAddress Street
setStreetNumber(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
 
setTelephoneNumbers(Collection<TelephoneNumber>) - Method in interface com.softwareag.centrasite.api.csom.User
Sets the given collection of telephone numbers to the user
setType(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
Set the PostalAddress type
setURI(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
Set the repository relative path in case it refers to CentraSiteRepositoryObject other wise external URL.
setURIGenerator(CSOUriGenerator) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
The URI format is not fixed but greatly depends on the CSO client.
setUserSelectedExportOptions(Collection<ExportOption>) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
Set the options for export
setUserVersion(String) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
Sets the user version for the registry object that is being created as part of this activity
setUserVersion(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
Sets the user-defined version identifier for the asset.
setUserVersion(String) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
Sets the user version for hte new version.
setUserVersion(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
Updates the user version according to the given parameter
setValue(String) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
 
setValue(Locale, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Sets the String value for the specified Locale.
setValue(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
Sets the String value for the user locale.
setValue(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
Set the String value for the specified object
setValues(List<?>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
Sets the parameter of the condition.
SimpleAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
SimpleAttribute interface represents the simple attributes of a CentraSiteObject.
size() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchResult
Returns the size of the search result
SLOT_PERMISSION_NAMESPACE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
SMTP_PROPERTIES_PATH - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
STR_CENTRASITE_CONTEXT - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
STR_EMAIL_TEMPLATE_FOLDER - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
STR_MIME_TYPE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
STR_ROKEY - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
STR_SPACE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
SUPPORTING_DOC_LOCATION - Static variable in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryObject
 
SYSTEM_CONFIGURATION_SEARCH_COMMON_ATTRIBUTES - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
SYSTEM_CONFIGURATION_SEARCH_CONDITION_PATH - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
SYSTEM_CONFIGURATION_SEARCH_SCOPE_PATH - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 

T

Taxonomy - Interface in com.softwareag.centrasite.api.csom
A Taxonomy instance represents a taxonomy that may be used to classify or categorize RegistryObject instances.
TECHNICAL_DETAILS_PROFILE_FOR_VIRTUAL_TYPES - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
TelephoneNumber - Class in com.softwareag.centrasite.api.csom
This object will hold the details of the telephone number such as country code, area code, number, extension etc
TelephoneNumber() - Constructor for class com.softwareag.centrasite.api.csom.TelephoneNumber
 
TOKEN_ENTITY_DESCRIPTION - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_NAME - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_OBJECT_XML - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_ORGANIZATION - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_OWNER - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_STATE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_TYPE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_URL - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ENTITY_VERSION - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ERROR_ACTION - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ERROR_EXPLANATION - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ERROR_ID - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ERROR_MESSAGE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_ERROR_STACKTRACE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_PROPERTY_ALL - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_PROPERTY_SYSTEM_CURRENT_LOCALE - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_PROPERTY_SYSTEM_DISPLAY_NAME - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_PROPERTY_SYSTEM_REPOSITORY_URL - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
TOKEN_PROPERTY_SYSTEM_USER_NAME - Static variable in interface com.softwareag.centrasite.api.diagnostic.DiagnosticConstants
 
toString() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
Overrides Throwable.toString() method Returns the message text of an exception message with the given message Id.
toString() - Method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
 
TYPE_CLASSIFICATION - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_COMMON - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_COMPUTED - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_FILE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_RELATIONSHIP - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_REPORT_ATTRIBUTE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 
TYPE_SIMPLE - Static variable in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
 

U

UnwatchAction - Interface in com.softwareag.centrasite.api.csom.action
The UnwatchAction interface facilitates to unwatch or unsubscribe to changes in the CentraSite registry objects.
User - Interface in com.softwareag.centrasite.api.csom
The User interface serves as a common interface for the user related information.
USER_EMAIL_ADDR_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to retrieve email address of the user from user information map for 'Request Account'.
USER_FIRST_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
USER_LAST_NAME - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
USER_REGISTRATION_ADMIN_EMAIL_SUBJECT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
USER_REGISTRATION_REQUEST_SUCCESS - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
USER_REGISTRATION_USER_EMAIL_SUBJECT - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
 
USER_REGISTRATOR_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key used to represent UserRegistration implementation class.
USERNAME_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
Key for retrieving username
UserPreferences - Interface in com.softwareag.centrasite.api.csom
The UserPreferences interface provides various methods that facilitate to manage the user preferences.
UserRegistrationEmailConstants - Interface in com.softwareag.centrasite.api.common.constants
UserRegistrationEmailConstants interface includes user-specific constants that act as identifying tokens
UserRegistrationException - Exception in com.softwareag.centrasite.api.common.exception
Exception thrown when any error occurs while registering the user in CentraSite
UserRegistrationException(CLLMessage, Throwable) - Constructor for exception com.softwareag.centrasite.api.common.exception.UserRegistrationException
 
UserRegistrationException(CLLMessage) - Constructor for exception com.softwareag.centrasite.api.common.exception.UserRegistrationException
 
Users - Static variable in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
 

V

validate() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
Validate the search, return the collection of validation objects
validate(CSOSearch) - Method in interface com.softwareag.centrasite.api.csom.search.validation.Validator
Perform the validation on given CSOSearch and return the violations as CSOValidationInfo.
ValidationInfoType - Enum in com.softwareag.centrasite.api.csom.search.validation
ValidationInfoType describes the level of the Validation.
Validator - Interface in com.softwareag.centrasite.api.csom.search.validation
Validator used to perform the different types of validations.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.action.ActionStateEnum
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.action.AssetSupportedOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.action.ExportOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.action.ReportFormats
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.NotificationOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.search.CSOSearch.SearchType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.search.CSOSortSpecifier.Direction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.search.Operator
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.softwareag.centrasite.api.csom.search.validation.ValidationInfoType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.action.ActionStateEnum
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.action.AssetSupportedOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.action.ExportOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.action.ReportFormats
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.NotificationOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.search.CSOSearch.SearchType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.search.CSOSortSpecifier.Direction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.search.Operator
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.softwareag.centrasite.api.csom.search.validation.ValidationInfoType
Returns an array containing the constants of this enum type, in the order they are declared.
VERSIONING_CHANGELOG_SLOT - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
ViewReportAction - Interface in com.softwareag.centrasite.api.csom.action
The ViewReportAction interface allows to view reports that are available for the CentraSite object.

W

WatchAction - Interface in com.softwareag.centrasite.api.csom.action
The WatchAction interface facilitates to watch or subscribe to changes in the CentraSite registry objects.
WEBDAV_BASE_SUFFIX - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 
WEBDAV_RESOURCE_SEPERATOR - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
 

X

XMLSchema - Interface in com.softwareag.centrasite.api.csom
XMLSchema instances are CentraSiteRegistryObject that provide information on XMLSchema offered by an Organization.
XPATH_EMAIL_ADDRESS_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
XPATH_EMAIL_PRE_SUB_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 
XPATH_EMAIL_TEMPLATE_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
 

A B C D E F G H I J K L M N O P Q R S T U V W X