- GET_ORGANIZATIONS - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
-
- getAboutTopics(ClientAboutInfo) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the topics to be displayed in the About page in BusinessUI.
- 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
-
Returns the action to be taken for the message.
- getAction(String) - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the
CSOAction
for the specified action Id.
- getActionInstance() - Method in class com.softwareag.centrasite.api.csom.policy.BasePolicyActionExtensionParser
-
Gets the policy action instance object.
- getActionInstance(String) - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionExtensionParser
-
- getActionManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the action manager associated with this session.
- getActionTemplate() - Method in class com.softwareag.centrasite.api.csom.policy.BasePolicyActionExtensionParser
-
Gets the policy action template object.
- getActivatePolicyInfo() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKey
-
Returns the API configuration information.
- 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 underlying activity implementation class.
- 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
-
- getAdministrator() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Get one of the Administrator user(s) for the current Organization.
- getAdministrators() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Get the administrators of the organization.
- getAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Return the existing aliases for the selected service.
- getAliases() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Returns the existing alias for the selected service.
- getAliases(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.util.ProfileOverviewManager
-
Lists all the aliases for a given asset.
- getAliasListForUnDeploy() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Gets the aliases which have to be unpublished from the targets.
- getAliasTargetsMap() - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Gets a list of targets to which the aliases are to be published.
- getAliasTargetsMap() - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Gets a list of targets from which the aliases have to be unpublished.
- 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 the Configuration items from the configuration XML.
- 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 the registry object.
- 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 states that exist in the LCM.
- getApiID() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Get the id the API key.
- getApiId() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the UUID of the API (service) for which the user requests on-boarding.
- getApiId() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the apiId property.
- getApiKey() - Method in class com.softwareag.centrasite.api.privilege.service.APIKeyPolicyRequest
-
Gets the API key.
- getApiKeyApprovalModel() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the API key approval models.
- getApiName() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the apiName property.
- getApplicableEnforcements() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Gets the list of enforcements applicable for the consumer.
- getApplicableExportOptions() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
-
Return the 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 organizations for the action.
- getApplicableReports() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Returns the collection of all applicable reports.
- getApplicableTargets() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Fetches all the targets that are applicable.
- getApprovalEmailType() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Gets the approval email type.
- getApprovalPolicy() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the approvalPolicy property.
- 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.
- getApprovalRequestType() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Get the type of the approval request.
- 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.
- getApproveConfig() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Gets the email configuration for an "Approval Request" for an API key.
- getApprovedConfig() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Gets the email configuration for an "Approved" API key.
- getApproverGroupIds() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the ids of all the approver groups.
- getApproverGroupIds() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the ids of all the approver groups.
- 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.
- getAttributeKey() - Method in interface com.softwareag.centrasite.api.csom.attribute.ClassificationAttribute
-
Gets the UUID key value for this classification attribute instance.
- getAttributeKey() - Method in interface com.softwareag.centrasite.api.csom.attribute.FileAttribute
-
Gets the attribute UUID key in CentraSite for the file attribute.
- getAttributeKey() - Method in interface com.softwareag.centrasite.api.csom.attribute.RelationShipAttribute
-
Gets the attribute UUID key for the relationship attribute.
- 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
-
Return the attribute names and values for this item.
- getAttributes() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Return the attributes of the CentraSitePolicyActionTemplate.
- 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
-
Returns a list of CentraSiteAttributes for this 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 given attribute name.
- 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.
- getAvaliableEmailTempalte() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKey
-
Gets the available email template from the repository.
- getAvatar() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get the profile picture's URL of the current user.
- getBaseDir() - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Gets the base directory path to publish.
- getBaseDir() - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Gets the base directory path to unpublish from.
- getBaseDir() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the base directory.
- 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).i.e., the actions that have a value as
true
for the attribute
bulk.
- getCallerId() - Method in class com.softwareag.centrasite.api.privilege.service.APIKeyPolicyRequest
-
Gets the UUID of the caller.
- 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
-
Gets the underlying registry object type for this attribute.
- getCentraSiteObjectTypeManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the type manager associated with this session.
- getCentraSitePermission() - Method in interface com.softwareag.centrasite.api.csom.Permission
-
Get the RAM specific CentraSitePermission
instance that is wrapped by this instance.
- getCentraSitePolicyActionTemplate() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
- getCentraSitePrivilege(String) - Static method in enum com.softwareag.centrasite.api.csom.action.CentraSitePrivilege
-
- getCentraSitePrivilege(Character) - Static method in enum com.softwareag.centrasite.api.csom.action.CentraSitePrivilege
-
- getCentraSiteRole() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the RAM CentraSiteRole
instance that is wrapped by this instance.
- getCentraSiteSession() - Method in class com.softwareag.centrasite.api.csom.policy.BasePolicyActionExtensionParser
-
Gets the CentraSite session object.
- getChangeLog() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
-
Returns the change log parameter.
- getChapters() - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionTemplatesTree
-
- getCharsetName() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
-
Gets the canonical name for the charset of this object.
- getChildAttributes() - Method in interface com.softwareag.centrasite.api.csom.attribute.ObjectTypeAttribute
-
Gets the list of child policy action parameters for this policy action parameter attribute.
- 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 immediate 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
-
Obtains the number of children under this taxonomy.
- getChildOrganizationCount() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets the count of child organizations 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
-
Returns the Web Application directory location for the client.
- getClientTopicsForAdmin() - Method in interface com.softwareag.centrasite.api.about.ClientAboutInfo
-
Return the list of topics related to the Administrator.
- getCLLMessage() - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionValidationInfo
-
Gets the CLL message instance.
- getCommonAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
Returns the list of common attributes that are configured in System configuration.
- getCompleteApprovalUsing() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the user name using which the API key approval should be completed.
- getComputedProfileClass() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
-
Gets the computed profile implementation class.
- getCondition() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
-
- 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.
- getConsumerCertificate() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the consumer certificate.
- getConsumerName() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Consumer of the deployed service.
- 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(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return the list of consumers associated with the given asset.
- getConsumers() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the users who are registered as Consumers for this CentraSiteRegistryObject.
- getContentType() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Gets the file content type.
- getContentType() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
-
Gets the content type of repository file.
- getContentTypes() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the content types supported by this resource.
- 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.
- getDbUrl() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
-
Get the database URL configured by the installer.
- getDefaultRepositoryFolder(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
- getDefaultRepositoryFolder() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get the default repository folder 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.
- getDependentPolicyActionInstances() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Gets the collection of policy action instances that are dependent on this policy action instance.
- getDependentPolicyActionTemplates() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Gets the dependent policy action templates.
- getDeployedTargets() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the list of targets to deploy.
- getDeployedTargets(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return the list of targets where given asset is deployed.
- getDeployedTargetsCount() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the number of targets to which deployment has happened.
- getDeploymentEndPoint() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Gets the URL of the endpoint for the target's deployment service.
- getDeploymentManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the deployment manager.
- getDeploymentStatus() - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
Gets the status of deploying a service.
- 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 (any level).
- 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 for the given locale.
- getDescription() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Returns the file description.
- getDesignTimePolicyId() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the design time policy id.
- getDesignTimePolicyId() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the designTimePolicyId property.
- getDesigntimePolicyId() - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Gets the value of the designtimePolicyId property.
- 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
-
Gets the direction value.
- getDisplayLanguage() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the display language set for this session.
- 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.Group
-
Get the display name for the group.
- getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the display name for the role.
- getDisplayName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
-
Return the display name of the parameter in currently logged in user locale.
- getDisplayName(Locale) - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
-
Return the display name for the parameter in the given locale.
- 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 display 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.
- getDisplayType() - Method in interface com.softwareag.centrasite.api.csom.attribute.SimpleAttribute
-
Returns the display type of the attribute.
- getDisplayURI() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Return the URI which is displayed to the user.
- getDisplayVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Retrieves the display version of a CentraSiteRegistryObject.
- getDocuments() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the list of documents attached for this resource.
- getDownloadContent() - Method in interface com.softwareag.centrasite.api.csom.action.DownloadDocumentAction
-
- getEditPageURL() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
-
This method is used to return the context path of the edit view.
- getEffectiveSearchScopes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Returns the consolidated collection of search scopes based on the
specified scopes.
- getEmail() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the user's email address.
- 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.
- getEmailSettings() - Method in class com.softwareag.centrasite.api.privilege.service.ApprovalPolicy
-
Gets the value of the emailSettings property.
- getEmailSubject() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Gets the subject in the approval notification email.
- getEmailSubject() - Method in class com.softwareag.centrasite.api.csom.action.runtime.EmailConfiguration
-
Gets the email subject for the configuration.
- getEmailTemplate() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Gets the email template name.
- getEmailTemplate() - Method in class com.softwareag.centrasite.api.csom.action.runtime.EmailConfiguration
-
Gets the email template.
- getEmailType() - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Gets the value of the emailType property.
- getEndpointName(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the endpoint name from the endpoint id.
- getEndPoints() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get the endpoint URI appended with each resource name.
- getEndPoints() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the endpoints supported by the Service.
- getEndpointUri() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Gets the endpoint URI for the service.
- getEnforceActionCondition() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the enforce action condition.
- 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.
- getEventDetailsAttributes() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Obtains the attributes for the event details.
- getEventId() - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Gets the event id.
- getEventId() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Event unique identity.
- getEventType() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Type of the event.
- 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
-
Get the existing lists owned by the logged in user.
- getExpirationDate() - Method in interface com.softwareag.centrasite.api.csom.APIKey
-
Get the expiration date for this API key.
- getExpirationInterval() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the expiration interval for the API key.
- getExpirationInterval() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the expiration interval for the API key.
- getExpirationInterval() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the expirationInterval property.
- 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
-
Returns the message explanation.
- 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
-
Gets the string equivalent of the export option.
- 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.
- getExternalProperties() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Obtain the external properties for this group.
- getExternalProperties() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get the user's external repository properties.
- getFailedActivityIds() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
-
Returns list of failed activity Ids.
- getFailedDeploymentActivity() - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
Gets the failed deployment activity instance if deployment failed.
- getFailedDeploymentMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Returns the failed deployment status as key-value pair of (target, status message).
- getFailedDeploymentTargets() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the list of targets where deployment failed.
- getFailureCause() - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
Gets the cause of the failure if deployment has failed.
- getFileAttributeValue() - Method in interface com.softwareag.centrasite.api.csom.attribute.CSOComputedAttribute
-
Gets the File attribute value.
- 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.
- 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 the First Name of the current user.
- getFirstName() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the user's first name.
- 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 |
+------------------+ +-----------------+
|
V
+-----------------+
| centrasite2.txt |
+-----------------+
In case of the above folder structure, getFolders("/projects", "centrasite") returns folder
"/projects/centrasite1".
- getFolders() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFolder
-
Return the folders nested directly under this folder.
- getGlobalPolicyName() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Gets the global policy's name.
- getGroup() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
-
Gets the group Id to which this action belongs.
- getGroupDetailActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the list of actions applicable for the group details page.
- getGroupId() - Method in class com.softwareag.centrasite.api.privilege.service.ApprovalPolicy
-
Gets the value of the groupId property.
- getGroups() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Retrieves the list of groups which are assigned the current role.
- getGroupsOfUser() - Method in interface com.softwareag.centrasite.api.csom.User
-
Retrieves the list of groups of which this user is a part of.
- getGroupsSearch() - Method in interface com.softwareag.centrasite.api.csom.action.AddToGroupAction
-
Get the groups search instance.
- getGuestUserLocale() - Method in interface com.softwareag.centrasite.api.service.CentraSiteService
-
This method return the guest user locale.
- getHandle() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the handle.
- getHelpCenter() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Return the HelpCenter which is used to access the available HelpCenterTopics.
- getHttpMethods() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the HTTP methods supported by this resource.
- 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 (UUID) for the object.
- getId() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Get the unique identifier for the group.
- getId() - Method in interface com.softwareag.centrasite.api.csom.HelpCenterTopic
-
An unique identifier of the topic.
- getId() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the UUID key for the role.
- getIdentificationTokens() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the identification tokens.
- 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.CentraSiteFile
-
Gets the file's input stream content.
- 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.csom.util.ProfileOverviewManagerFactory
-
- getInstance() - Static method in class com.softwareag.centrasite.api.service.CentraSiteServiceFactory
-
Gets the factory instance.
- getInstancePermissionMap() - Method in interface com.softwareag.centrasite.api.csom.action.PermissionAction
-
Gets the instance level permission map.
- getInstancePrivilege() - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Gets the instance level privileges.
- getInstancePrivilege() - Method in class com.softwareag.centrasite.api.csom.action.PermissionModel
-
Gets the instance level privileges.
- getInternalRepositoryPath() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the internal repository path.
- getIpv4FromAddresses() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the IPV4 from addresses.
- getIpv4ToAddresses() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the IPv4 to addresses.
- getIpv6FromAddresses() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the IPV6 from addresses.
- getIpv6ToAddresses() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the IPv6 to addresses.
- 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
-
- getItems(List<String>) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
-
- getItemValue(String) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
-
Get the item value for a given path.
- getJson() - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionExtensionParser
-
Returns the policy action template/instance information as a JSON string.
- getKey() - Method in interface com.softwareag.centrasite.api.about.AboutTopicValue
-
Return the localized name for this topic value.
- getKeyGenConfiguration() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the email configuration for the APIkey generation request.
- getKeyRenewalConfiguration() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the email configuration for the API Key renewal request.
- getKeyRevokeConfiguration() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the email configuration for API Key revocation.
- getLastName() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get Last Name of the current user.
- getLastName() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the users last name.
- getLCM() - Method in interface com.softwareag.centrasite.api.csom.LCMState
-
Return the LCM to which the state belongs.
- getLCMAssignment() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Return the lifecycle state information of the registry object.
- getLCMStateById(String) - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
-
Gets the LCMState by its id.
- getListOfGroups() - Method in interface com.softwareag.centrasite.api.csom.action.AddUserToGroupAction
-
Get the list of groups obtained after executing the search.
- getListOfRoles() - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Get the list of roles obtained after executing the search.
- getListOfUsers() - Method in interface com.softwareag.centrasite.api.csom.action.AddUserAction
-
Get the users obtained as a result of the search.
- 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
-
- getLocalName() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the Local-Name Classification value of this RegistryObject.
- getLocalStringValue(Locale) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteInternationalString
-
Gets the local String value for the specified Locale.
- getMainAssetFileName() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
Return the initially attached document original name.
- getMainAssetId() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
Return the Main Asset Id created using the attached documents.
- getManageOrgsActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Gets the list of actions related to "Manage Organizations activity".
- getManageOrgsSearch() - Method in interface com.softwareag.centrasite.api.activity.ManageOrganizationsActivity
-
Obtains the
CSOSearch
instance of the saved search for this activity.
- getMandatoryAttributeProfiles() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Return the list of profiles for the registry object in which there is at least 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.getMessage() 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
-
Returns the brief message text.
- 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 class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the message after deployment is done.
- getMessage() - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionValidationInfo
-
Gets the error message which specifies what stops the policy action from being
added to the message flow step.
- getMessage() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
-
The detailed message describes about the validation error.
- getMessage() - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Gets the value of the message property.
- getMessageFlow(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.VirtualizationService
-
Gets the MessageFlow
for the given service.
- getMessageFlow() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the MessageFlow
.
- getMessageFlowSteps(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
This method gets the message flow steps applicable for the given policy action template.
- getMessageID() - Method in class com.softwareag.centrasite.api.common.i18nresource.CLLMessage
-
Returns the message database id for the message.
- getMessageID() - Method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
-
Get the message id.
- getMessageObject() - Method in exception com.softwareag.centrasite.api.common.exception.CLLException
-
Returns the localized message object.
- getMessages(I18NMessageEnum, String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
-
Get a HashMap
of all messages for a specified message resource.
- getMessageWithParameters(I18NMessageEnum, String, Object[], String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
-
Get the localized message for a specific message key and locale.
- 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
-
Returns the I18N message formatted with specified parameters for a specific locale.
- 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.
- getModeName() - Method in enum com.softwareag.centrasite.api.csom.action.ApprovalMode
-
Returns the string value for the enum.
- getName() - Method in enum com.softwareag.centrasite.api.csom.action.AttachDocumentState
-
The string value for the enum.
- 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
-
- getName(Locale) - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
-
- getName() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Get the Name of the CentraSitePolicyActionTemplate.
- getName() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Return the file or folder name.
- getName() - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Gets the event attribute name.
- getName() - Method in interface com.softwareag.centrasite.api.csom.search.CSOParameter
-
Gets the name of the parameter.
- 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.AbstractXMLService
-
Get the namespace for the service.
- 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
-
Get the namespace Classification value of this RegistryObject.
- getNeedFrom() - Method in class com.softwareag.centrasite.api.privilege.service.ApprovalPolicy
-
Gets the value of the needFrom property.
- getNestedProfilePermissionModels() - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Gets the nested profile permissions.
- 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
-
Returns the UUID (identifier key) of the newly created asset.
- getNewVersionObjects() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
-
Returns the collection of newly versioned objects, null in case the 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.
- getoAuth2TokenExpirationInterval() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the expiration internal for the OAuth 2.0 token.
- 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.
- getOperation() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the deployment operation.
- getOperation() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the operation property.
- getOperationsMap() - Method in interface com.softwareag.centrasite.api.csom.Service
-
Gets the operations supported by the Service.
- 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
-
Gets the string value for the operator.
- getOptionsForAsset(String) - Static method in enum com.softwareag.centrasite.api.csom.action.AssetSupportedOption
-
This method returns the possible options supported for an asset for a given type id.
- getOptionsForAttach(String) - Static method in enum com.softwareag.centrasite.api.csom.action.AssetSupportedOption
-
Get the supported options for attaching files to an asset for a given type id.
- getOrganization() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Retrieves the belonging Organization of the CentraSiteRegistryObject.
- getOrganization() - Method in interface com.softwareag.centrasite.api.csom.LCM
-
Get the Organization this LCM is applicable for.
- getOrganizationAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
Returns set of attributes that are specifically defined for Organization objects.
- getOrganizationAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Returns set of attributes that are specifically defined for Organization objects.
- getOrganizationId() - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Get the organization id.
- getOrganizationName() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the organization's name to which the on-boarding user will be associated.
- getOrganizations() - Method in interface com.softwareag.centrasite.api.activity.ManageOrganizationsActivity
-
Returns all the organizations that the user can manage.
- getOrganizations() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get all organizations this user belongs to.
- getOrgDescription() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Get the description of the organization to which this group belongs.
- getOrgDescription() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the description of the organization to which this role belongs.
- getOrgDetailActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the list of actions applicable for the organization details page.
- getOrgId() - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Get the id of the owner's organization.
- getOrgName() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Get the name of the organization to which the group belongs.
- getOrgName() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the name of the organization to which this role belongs.
- 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.
- getOwnerId() - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Gets the owner (user/group) id.
- getOwnerLocale() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the locale defined for the currently logged in user.
- getOwnerName() - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Get the name of the user/group to whom this permission is applied.
- getOwnerName() - Method in class com.softwareag.centrasite.api.csom.action.PermissionModel
-
Get the name of the user/group to whom this permission is applied.
- getOwnerOrgName() - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
The name of the organization for the owner.
- 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
-
Returns 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.
- getPassword() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Gets The password of the Target's user to be used for the deployment operation.
- getPassword() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the password given by the user.
- getPath() - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
-
Returns the XPath of this element.
- 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.
- getPayloadTypeId() - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Gets the payload type id.
- getPendingApprovals() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Gets the pending approvals for the CentraSiteRegistryObject.
- getPendingState() - Method in interface com.softwareag.centrasite.api.csom.LCMStateAssignment
-
Returns the pending state of the registry objects, if it exists, otherwise returns null.
- getPermissionAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
- getPermissionAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getPermissions() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Get the permissions of the role.
- getPermissionsSearch() - Method in interface com.softwareag.centrasite.api.csom.action.AddRoleAction
-
Get the permissions search for the role.
- getPermissionsSearch() - Method in interface com.softwareag.centrasite.api.csom.action.AssignPermissionAction
-
Get the search instance for searching permissions.
- 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.
- getPoilcyActionTemplates(Category) - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionTemplatesTree
-
- getPolicyActionInstance(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return an existing PolicyActionInstance based on the policyActionInstance identifier.
- getPolicyActionsTree() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the PolicyActionTree
, which is used to render PolicyActionTemplates in
hierarchical order.
- getPolicyActionTemplate(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return PolicyActionTemplate by the given PolicyActionTemplateId.
- getPostalAddress() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets the PostalAddress for this organization.
- 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
-
Obtains the set of all post-login related keys.
- getPostloginLocaleMessages(String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
-
Obtains post-login related messages as a key value paired HashMap
for a specific locale.
- 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
-
Obtains the set of all pre-login related keys.
- getPreloginLocaleMessages() - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
-
Obtains pre-login related messages as a key value paired HashMap
for the default locale.
- getPreloginLocaleMessages(String) - Static method in class com.softwareag.centrasite.api.common.i18nresource.I18NMessageUtil
-
Obtains pre-login related messages as a key value paired HashMap
for a specific locale.
- getPreviousVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
- getPreviousVersions() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Retrieves the List of CentraSiteRegistryObjects 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
-
- getPrivilege() - Method in interface com.softwareag.centrasite.api.csom.ACL
-
Gets the ACL Privilege.
- getPrivilegeServiceOperation() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the privilege service operation type.
- getProcessedObjectsCount() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
-
Get the number of processed objects in the process of exported action.
- getProfileDataAsJson() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
-
Returns the Profile data which need to render in the view as JSON.
- getProfileId() - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Gets the profile id.
- 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.
- getProfileName() - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Gets the profile name.
- getProfileOverviewManager(CentraSiteSession) - Method in class com.softwareag.centrasite.api.csom.util.ProfileOverviewManagerFactory
-
Constructs the ProfileOverviewManager instance from the CentraSite session.
- getProfilePermissionMap() - Method in interface com.softwareag.centrasite.api.csom.action.PermissionAction
-
Gets the profile permission map.
- getProfilePrivilege() - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Gets the profile level privileges.
- getProfileTemplateWebDavPath() - Method in interface com.softwareag.centrasite.api.csom.type.Profile
-
This method returns the WebDAV location of the files which can render the profile.
- getProgress() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Returns number of deployment requests made which highlight the deployment progress.
- 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.
- getQueryStrings() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the query strings for this resource.
- getReason() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the user's reason for requesting on-boarding.
- getReasonForRequest() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Gets the reason for requesting the approval.
- getReferencedScopeId() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
-
Returns the referenced Scope Id from CSOTypeScope.
- getRefreshLimit() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets an integer value which is the number of times the API key can be refreshed.
- getRegisteredGroups(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the groups registered with CentraSite from the internal repository using the specified search filter.
- getRegisteredGroups(String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the Groups registered with CentraSite, except for the ones already assigned to the given userId with the specified search filter.
- getRegisteredRoles(String, String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the roles registered with CentraSite, except for the ones already assigned to the given userId (could be group id or user id) with the specified search filter.
- getRegisteredRoles(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the Registered Roles from the internal repository using the specified search filter.
- 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.
- getRejectConfig() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Gets the email configuration for a "Rejected" API key.
- getRelationShipType() - Method in interface com.softwareag.centrasite.api.csom.attribute.CSOComputedAttribute
-
Gets the category of the relationship type for the computed attribute.
- 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
.
- getRequestDate() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Gets the date of the approval request.
- getRequestPayloadData(Long) - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeManager
-
This method returns the request pay load data.
- getRequestType() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Get the type of the request.
- getResource() - Method in enum com.softwareag.centrasite.api.common.i18nresource.I18NMessageEnum
-
Get the message resource name.
- getResource(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get a particular resource of a service by its UUID.
- getResources() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get the resources for the service.
- getResponsePayloadData(Long) - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeManager
-
This method returns the response pay load data.
- getResultAttribute() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
-
- 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 already configured with the search object.
- getRoleAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
- getRoleAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getRoleDetailActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the list of actions applicable for the role details page.
- getRolesOfGroup() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Retrieve the collection of roles assigned to the group.
- getRolesOfUser() - Method in interface com.softwareag.centrasite.api.csom.User
-
Retrieves the roles assigned to a user.
- getRolesSearch() - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleAction
-
Get the search instance to search for roles to assign.
- getRootOrganziation() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets the root organization.
- getRuntimeEventTypes() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return the list of RuntimeEvent Types.
- getRuntimeManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the runtime manager instance.
- getRuntimePolicyID() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the runtime policy id.
- getRunTimePolicyId() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the runTimePolicyId property.
- getRuntimePolicyId() - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Gets the value of the runtimePolicyId property.
- getRuntimeValues() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Gets the runtime related values specific to the approval flow.
- 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.
- getSchemaAccessUrl(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the schema access URL for the resource.
- getSchemaId() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the UUID for the attached schema for the resource.
- 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.
- getSearchResultGroups() - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Obtain the result of searching for groups.
- getSearchScope() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
- 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.
- getSections(Category) - Method in interface com.softwareag.centrasite.api.csom.policy.PolicyActionTemplatesTree
-
- getSelectedAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Return the selected alias(es) for the native service.
- getSelectedEndPoint(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Return the selected end point for the given alias.
- getSelectedOrganization() - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
-
Returns the organization parameter of the action.
- getSelectedReport() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Returns the selected report.
- getService(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.util.ProfileOverviewManager
-
Returns the native service of a given virtual service.
- getServices() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets all the Services for the current Organization.
- getSimpleAttributeType(String) - Static method in class com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
-
Gets the simple attribute type for the given policyParameterType.
- getSimpleAttributeTypes() - Static method in class com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttributeDataType
-
Returns the data types for attributes which comes under
SimpleAttribute
category.
- 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). i.e., the actions that have a value as
false
for the attribute
bulk.
- 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
-
Returns the assigned sort specifier to the CSOSearch.
- getSortSpecifier() - Method in interface com.softwareag.centrasite.api.csom.search.validation.CSOValidationInfo
-
- getStackTrace(Throwable) - Static method in class com.softwareag.centrasite.api.diagnostic.DiagnosticContext
-
Get the stack trace string from the given Throwable instance.
- getStateOrProvince() - Method in class com.softwareag.centrasite.api.csom.PostalAddress
-
Returns the PostalAddress state province.
- getStatus() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the deployment status.
- 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.
- getSubject() - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Gets the value of the subject property.
- getSubscribers() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the users who have subscribed to (or watching) this CentraSiteRegistryObject for notifications.
- getSupportedOptions() - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
- getSystemVersion() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Retrieves the system version of the CentraSiteRegistryObject.
- getTargetName() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Target at which the service is deployed.
- getTargetObjectTypes() - Method in interface com.softwareag.centrasite.api.csom.attribute.CSOComputedAttribute
-
Gets the target registry object types for the computed attribute.
- getTargetObjectTypes() - Method in interface com.softwareag.centrasite.api.csom.attribute.RelationShipAttribute
-
Returns the collection of CentraSiteRegistryObjectType.
- getTargets() - Method in interface com.softwareag.centrasite.api.csom.runtime.TargetType
-
Gets all the targets that are created for the Target Type.
- getTargets() - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Gets the List of configured Targets.
- getTargetType() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
- 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 organization 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.
- getTemplatePath() - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Gets the value of the templatePath property.
- getTimestamp() - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeEvent
-
Time at which event is raised.
- getTitle() - Method in interface com.softwareag.centrasite.api.about.AboutTopic
-
Return the title of this topic.
- getTitle(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Returns the string corresponding to the given messageId based on User locale.
- 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.
- getTopLevelResource() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
For every REST/XML service, there can be only one top-level resource.
- 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 its 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 for the given display URL.
- 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
-
- getType() - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Gets the template type.
- 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
-
Returns the type of the report search parameter.
- 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
-
- getType(QName) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Populate the CentraSiteObjectType persisted using the given QName
.
- getType() - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Gets the value of the type property.
- getTypeByDisplayName(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Creates 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 attached with the search scope.
- 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.
- getUnPublishAliasList() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Gets the aliases which have to be unpublished from the targets.
- getUnRegisteredGroups(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the unregistered external groups from the external repository using the specified search filter.
- getUnRegisteredUsers(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Returns the external users from the external repository using the specified search filter.
- 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.
- getUser() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Gets the username or user ID of the Integration Server user to be used for
the deployment operation.
- getUserAttributes() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
- getUserAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getUserDetailActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the list of actions applicable for the user details page.
- getUserPreferences() - Method in interface com.softwareag.centrasite.api.csom.User
-
- getUsers() - Method in interface com.softwareag.centrasite.api.csom.Group
-
Get the users of this group.
- getUsers() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets the Collection of Users affiliated with this Organization (belonging to this organization).
- getUsers() - Method in interface com.softwareag.centrasite.api.csom.Role
-
Retrieves the list of users who are assigned the current Role either directly or indirectly
inherited through role assignment to belonging group.
- getUserSelectedExportOptions() - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
-
Gets the collection of export options relevant for the objects specified in setObjects().
- getUsersSearch() - Method in interface com.softwareag.centrasite.api.csom.action.AssignUsersToGroupAction
-
Get the instance to execute the search for users.
- 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 this 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
-
Gets the element value.
- getValue() - Method in enum com.softwareag.centrasite.api.csom.action.ActionStateEnum
-
Get the string value for the enum.
- getValue() - Method in enum com.softwareag.centrasite.api.csom.action.ReportFormats
-
Gets the string value for the enum.
- 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
-
Get the string value for the enum.
- getValue() - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Gets the value of the attribute.
- getValue() - Method in enum com.softwareag.centrasite.api.csom.search.validation.ValidationInfoType
-
Gets the string value.
- getValues() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
-
Returns the parameters of the condition.
- getViewPageURL() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
-
This method use to return the context path of the Details view.
- getVirtualizationService() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the virtualization service for this session.
- getVisiblePrimaryProfiles() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the list of primary
Profile
s including inherited profiles in case of Virtual Types based on the current user permission.
- getVisibleProfile(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Return the primary or nested profile based which is visible based on the given id.
- getVisibleRoles() - Method in interface com.softwareag.centrasite.api.csom.User
-
Get the roles which are visible to this user.
- getWebPage() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Get the web page URL of current Organization.
- getXmlSchemas() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the XML schemas attached to the resource.
- GlobalReportActivity - Interface in com.softwareag.centrasite.api.activity
-
This activity will perform the action of generating reports based on the user inputs.
- grantAccessToEveryOne(Service) - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Triggers a policy which sets permissions to given assets & its dependents.
- Group - Interface in com.softwareag.centrasite.api.csom
-
This interface represents a Group object in CentraSite.
- GROUP_BASIC_INFO_PROFILE_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
-
- GUEST_FALL_BACK_LOCALE - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
-
- save() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
-
Saves the activity menu items belonging 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 collection of CentraSiteObjects.
- saveSearch(CSOSearch) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
- saveSearch(CSOSearch, boolean) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
- schemaAccessUrl(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get the schema access URL for the given schema Id.
- SEARCH_MANAGER_IMPL_CLASS_KEY - Static variable in interface com.softwareag.centrasite.api.common.constants.CLLConstants
-
- SECURITY_TREE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
-
- sendDiagnostics(DiagnosticContext) - Method in interface com.softwareag.centrasite.api.diagnostic.DiagnosticHandler
-
This method sends the diagnostic content to the configured email recipients.
- Service - Interface in com.softwareag.centrasite.api.csom
-
Services are
CentraSiteRegistryObject
s 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
-
- SERVICE_PATH - Static variable in interface com.softwareag.centrasite.api.configurator.ConfiguratorConstants
-
- setActivateKeyPolicyAvaliable(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets whether there should be a policy for activating the API key.
- setActivity(Activity) - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
-
Set the underlying activity implementation class.
- setActivityItemList(List<ActivityMenuItem>) - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
-
- setAddress1(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the address line 1 for the organization.
- setAddress2(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the address line 2 for the organization.
- setAdministrators(Collection<User>) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the organization's administrators.
- setAdministrators(Collection<User>) - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Set the administrators for the organization from the given collection.
- setAliasListForUnDeploy(Map<CentraSiteRegistryObject, List<Target>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the alias list for undeploying.
- setAliasName(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Sets the alias name.
- setAliasTargetsMap(Map<String, Collection<String>>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Sets the list of targets to which the aliases are to be published.
- setAliasTargetsMap(Map<String, Collection<String>>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Sets the list of targets from which the aliases have to be unpublished.
- setAll(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets whether approval is required from everyone in the group.
- setAny(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets if anyone in the group can approve an API key request.
- setAny(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets if anyone in the group can approve an API key request.
- setApiID(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the API key.
- setApiId(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the UUID of the API (service) for which the user requests on-boarding.
- setApiId(String) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the apiId property.
- setAPIKey(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether the key is an API key or not.
- setApiKey(String) - Method in class com.softwareag.centrasite.api.privilege.service.APIKeyPolicyRequest
-
Sets the API key.
- setApiKeyApprovalModel(List<APIKeyApprovalModel>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the API key approval models.
- setApiKeyRequested(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets if an API key is requested by the consumer or not.
- setApiName(String) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the apiName property.
- setApprovalEmailType(EmailType) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Sets the approval email type.
- setApprovalPolicy(ApprovalPolicy) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the approvalPolicy property.
- setApprovalRequired(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets whether approval for API key is required or not.
- setApprovalRequired(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether approval for API key is required or not.
- setApproveComments(String) - Method in interface com.softwareag.centrasite.api.csom.action.ApproveAction
-
Set the comments for approving a request.
- setApproveConfig(EmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Sets the email configuration for an "Approval Request" for an API key.
- setApprovedConfig(EmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Sets the email configuration for an "Approved" API key.
- setApproverGroupIds(List<String>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the ids the groups who can approve an API key request.
- setApproverGroupIds(List<String>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the ids the groups who can approve an API key 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.
- setAssetType(CentraSiteObjectType) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Sets the asset type.
- 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
-
Set the attribute names and values for to be set for this element.
- setAttributeValue(String, String) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
-
Set the value for the attribute with the given name.
- 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.
- setBaseDir(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Sets the base directory path to publish to.
- setBaseDir(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Sets the base directory path to unpublish from.
- setCallerId(String) - Method in class com.softwareag.centrasite.api.privilege.service.APIKeyPolicyRequest
-
Sets the caller's UUID.
- setChangeLog(String) - Method in interface com.softwareag.centrasite.api.csom.action.NewVersionAction
-
Sets the change log entry for the new version.
- setCharsetName(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteLocalizedString
-
Set the canonical name for the charset of this object.
- setCity(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the organization's city name.
- setCity(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
-
Set the PostalAddress city.
- setCompleteApprovalUsing(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the user name who can complete the approval request.
- setConditions(Collection<CSOSearchCondition>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Attach the search condition with the search object.
- setConsumeApiRequest(boolean) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets whether the request is a Consume API request or not.
- setConsumerCertificate(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the consumer certificate.
- setConsumerName(String) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the consumer name.
- setConsumptionReason(String) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the reasoning for the current consumption request.
- setContentType(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Sets the content type of the file.
- setContentTypes(Set<String>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the content types supported by this resource.
- setCountry(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the country where the organization is located.
- 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 in case of a need to protect documents.
- setDeactivate(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether the API key should be deactivated.
- setDependentPolicyActionInstances(Collection<CentraSitePolicyActionInstance>) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Sets the dependent policy action instances of this policy action instance.
- setDeployedTargetsCount(int) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the number of targets to which deployment has happened.
- setDeploymentEndPoint(URL) - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Sets the the URL of the endpoint for the target's deployment service.
- 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.action.AddOrganizationAction
-
Set the organization's description.
- 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 for the given locale.
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Set the description for the file.
- setDesignTimePolicyId(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the design time policy id.
- setDesignTimePolicyId(String) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the designTimePolicyId property.
- setDesigntimePolicyId(String) - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Sets the value of the designtimePolicyId property.
- 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.
- setDocuments(List<CentraSiteFile>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the documents to be attached to the resource.
- setEmail(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the user's email address.
- setEmailAddress(String) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
If the consumer does not have an email address as part of user preferences, it can
be specified using this API.
- setEmailAddresses(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.User
-
Sets the given collection of email addresses to the current user.
- setEmailEnabled(boolean) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets whether email notification should be enabled for the user so that the API key can be sent to the consumer.
- setEmailSubject(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Sets the approval notification email subject.
- setEmailSubject(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.EmailConfiguration
-
Sets the email subject.
- setEmailTemplate(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyApprovalModel
-
Sets the email template name.
- setEmailTemplate(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.EmailConfiguration
-
Sets the email template.
- setEmailType(EmailType) - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Sets the value of the emailType property.
- setEnabled(boolean) - Method in class com.softwareag.centrasite.api.activity.ActivityMenuItem
-
Set information regarding this menu item's visibility - whether the menu items's
visibility is enabled or not.
- setEndPointOrResource(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Sets the user selected end point for service or resource for REST/XML service.
- setEndpointUri(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the endpoint URL for the REST/XML service.
- setEnforceActionCondition(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Sets the AND/OR condition for enforcing actions.
- setEnforcementValues(Map<String, Object>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the given enforcement values.
- 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.
- setEventId(String) - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Sets the eventId.
- 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.
- setExistingAlias(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Sets the existing alias id.
- setExistingList(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.action.AddToListAction
-
Sets the objects to a given existing list.
- setExpirationInterval(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the API key expiration interval.
- setExpirationInterval(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the API key expiration interval.
- setExpirationInterval(String) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the expirationInterval property.
- setExpose(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Sets whether the published asset can be exposed to consumers.
- setExtension(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
-
Sets the extension code part of the Telephone Number.
- setFailedDeploymentTargets(Map<String, String>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the list of targets where deployment failed.
- 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.
- setFirstName(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the first name.
- setFromGlobalPolicy(boolean) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Sets if the policy action instance is from a global policy.
- setGlobalPolicyName(String) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Sets the global policy name.
- setGroupDesc(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set the group description.
- setGroupIdsForImport(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set the group ids which should be imported to CentraSite.
- setGroupName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set the group's name.
- setHandle(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the handle value.
- setHttpMethods(Set<String>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the HTTP methods supported by this resource.
- setHttpServletRequest(HttpServletRequest) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Sets the HTTP servlet request for this session.
- setId(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the UUID key for the resource.
- setIdentificationTokens(List<String>) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the identification tokens.
- setImportGroupMembers(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set whether the group members should be imported as users while importing external groups.
- 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.CentraSiteFile
-
Sets the input stream content for the file.
- setInputStream(InputStream) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteRepositoryFile
-
Specify the content for the file as input stream.
- setInstancePrivilege(List<CentraSitePrivilege>) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Sets the instance level privileges.
- setInstancePrivilege(List<CentraSitePrivilege>) - Method in class com.softwareag.centrasite.api.csom.action.PermissionModel
-
Sets the instance level privileges.
- setInteractiveResolution(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
If the set interactive resolution is true, then the system won't interact
with the user in case missing document already exists.
- setInternalRepositoryPath(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the internal repository path.
- setIpv4FromAddresses(List<String>) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the IPv4 from addresses.
- setIpv4ToAddresses(List<String>) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the IPv4 to addresses.
- setIpv6FromAddresses(List<String>) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the IPv6 from addresses.
- setIpv6ToAddresses(List<String>) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the IPv6 to addresses.
- setIsAutoApproval(boolean) - Method in class com.softwareag.centrasite.api.privilege.service.ApprovalPolicy
-
Sets the value of the isAutoApproval property.
- setIsLocalGroupCreation(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set whether a local group or an external group is being created.
- setIsLoggedInOwner(boolean) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Set if the logged in user is the owner.
- setItems(List<ConfiguratorItem>) - Method in interface com.softwareag.centrasite.api.configurator.Configurator
-
Sets the given Configuration Items.
- setKeyGenConfiguration(ApprovalEmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the email configuration for the API key generation request.
- setKeyRenewalConfiguration(ApprovalEmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the email configuration for the API Key renewal request.
- setKeyRevokeConfiguration(EmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the email configuration for API Key revocation.
- setLastName(String) - Method in interface com.softwareag.centrasite.api.csom.User
-
Sets Last Name for the current user.
- setLastName(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the user's last name.
- setLCMState(LCMState) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set the LCMState to CentraSiteRegistryObject.
- setListOfSelectedGroups(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserToGroupAction
-
Sets the list of groups to give the user membership.
- setListOfSelectedRoles(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Set the list of roles selected to be assigned to a user.
- setListOfSelectedUsers(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserAction
-
Sets the list of selected users as the ones to import into and register with CentraSite.
- 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 the Local-Name Classification of this RegistryObject.
- setMailMeAPIKey(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Enable/disable the "mail me API key" option.
- setMailMeOption(boolean) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
-
Enable/disable the mail me generated API key option for current logged in user.
- setMatchAnySpecifier(boolean) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Sets the match-any specifier.
- setMessage(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the deployment message.
- setMessage(String) - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Sets the value of the message property.
- setMessageFlow(MessageFlow) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Set the MessageFlow
constructed with the user selected policy Actions.
- 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.action.AddOrganizationAction
-
Set the organization's name.
- 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 class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Sets the event attribute 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.AbstractXMLService
-
Set the service namespace.
- 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 the namespace Classification of this RegistryObject.
- setNeedFrom(NeedFrom) - Method in class com.softwareag.centrasite.api.privilege.service.ApprovalPolicy
-
Sets the value of the needFrom property.
- setNestedPermissionModels(List<ProfilePermissionModel>) - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Sets the nested profile permissions.
- 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
-
Sets the Number part of the Telephone Number.
- setNumberSeparator(boolean) - Method in interface com.softwareag.centrasite.api.csom.UserPreferences
-
Enable or disable the number separator.
- setOAuth(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether OAuth should be active or not.
- setoAuth2TokenExpirationInterval(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the OAuth 2.0 token expiration interval.
- setOAuthDeactivate(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether OAuth should be deactivated or not.
- 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.
- setOnboardingRequest(OnboardingRequest) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the given consumer on-boarding request.
- setOperation(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the deployment operation.
- setOperation(Operation) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the operation property.
- 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 belonging Organization of the CentraSiteRegistryObject.
- setOrganizationAdministrator(boolean) - Method in interface com.softwareag.centrasite.api.csom.Role
-
Set whether this role is the Organization Administrator role or not.
- setOrganizationName(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the organization's name to associate with the user.
- setOrgId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserAction
-
Set the id of the organization to which the users must be imported.
- setOrgId(String) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Set the id of the owner's organization.
- 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.
- setOwnerId(String) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Sets the owner id.
- setOwnerName(String) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Set the user/group name.
- setOwnerName(String) - Method in class com.softwareag.centrasite.api.csom.action.PermissionModel
-
Set the user/group name.
- setOwnerOrgName(String) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Set the owner's organization name.
- setParameter(String, List<Object>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Set the parameters for the predefined search.
- setParentOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the parent organization for the organization.
- setPassword(String) - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Sets the password of the user to be used for the deployment operation.
- setPassword(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the password for the user.
- setPayloadDetails(boolean) - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Sets whether the events should have payload details or not.
- setPayloadTypeId(String) - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Sets the payload type id - Request/Response.
- setPermissionIds(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AddRoleAction
-
Set the permissions assigned to the role.
- setPermissionIds(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignPermissionAction
-
Set the permission ids which are selected to be assigned to the role.
- setPermissions(Map<String, List<CentraSitePrivilege>>, Map<String, Map<String, List<CentraSitePrivilege>>>) - Method in interface com.softwareag.centrasite.api.csom.action.PermissionAction
-
Set the permissions from the given values.
- setPhoneType(Category) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
-
Set the phone type.
- setPostalAddress(PostalAddress) - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Sets the postal address details of the current organization.
- setPostalCode(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the postal code for the organization's address.
- 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 the preview options are finalized.
- setPrimaryContact(User) - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Set the primary contact for the organization.
- setPrivilege(int) - Method in interface com.softwareag.centrasite.api.csom.ACL
-
Sets the ACL Privilege.
- setPrivilegeServiceOperation(Operation) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the privilege service operation type.
- setProfileId(String) - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Sets the profile id.
- setProfileName(String) - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Sets the profile name.
- setProfilePrivilege(List<CentraSitePrivilege>) - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Sets the profile level privileges.
- setPropagatePermissions(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.PermissionAction
-
Sets the flag that permissions should be propagated to dependent objects.
- setPropagatePermissions(boolean) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set whether the registry object should propagate the permissions to its dependent objects or not.
- setPropagateProfilePermissions(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.PermissionAction
-
Sets the flag that the profile permissions could be propagated to dependent objects.
- setPropagateProfilePermissions(boolean) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set whether this registry object can propagate its profile permissions to its dependent objects or not.
- 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 in the configuration.
- setProtected(boolean) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
-
Set whether the element should be protected or not.
- setQueryStrings(Set<String>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the query strings for this resource.
- setReason(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the user specified reason for requesting on-boarding.
- setReferencedScopeId(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
-
Sets the reference Scope Id on CSOTypeScope.
- setRefreshLimit(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the number of times the API key can be refreshed.
- setRejectComments(String) - Method in interface com.softwareag.centrasite.api.csom.action.RejectAction
-
Set the comments for rejecting a request.
- setRejectConfig(EmailConfiguration) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ApprovalEmailConfiguration
-
Sets the email configuration for a "Rejected" API key.
- 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.
- setResources(List<Resource>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Set the resources for the service.
- 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.
- setRevokeConsumability(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Sets the flag to revoke the consumability.
- setRoleDesc(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddRoleAction
-
Set the role's description.
- setRoleName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddRoleAction
-
Sets the created role's name.
- setRuntimePolicyID(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the runtime policy id.
- setRunTimePolicyId(String) - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Sets the value of the runTimePolicyId property.
- setRuntimePolicyId(String) - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Sets the value of the runtimePolicyId property.
- setSchemaId(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the schema id for the resource.
- setSearchAgain(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set whether the groups search should be executed again for a different search filter.
- setSearchFilter(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddGroupAction
-
Set the search filter to search for unregistered groups from the external repository.
- setSearchFlag(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserAction
-
Sets the search flag indicating whether the search to external repository should be executed or not.
- setSearchFlag(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserToGroupAction
-
Set the search flag to indicate whether the search should be executed or not.
- setSearchFlag(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Set the search flag indicating if the search should be executed.
- setSearchScope(CSOSearchScope) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
- setSearchScopes(List<CSOSearchScope>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Sets the collection of scopes for the search.
- setSelectedAliases(List<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the aliases for the service.
- setSelectedConsumerApplications(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the selected CentraSite objects as consumer applications.
- setSelectedGroups(Collection<Group>) - Method in interface com.softwareag.centrasite.api.csom.action.AddToGroupAction
-
Set the selected groups which are to be assigned to the user.
- 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.
- setSelectedRoles(Collection<Role>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleAction
-
Set the selected roles to be assigned to a group/user.
- 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.
- setSelectedUsers(Collection<User>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignUsersToGroupAction
-
Set the selected users to be assigned to a group.
- 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 the given sort specifier to the CSOSearch.
- setState(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the state where the organization is located.
- setStateOrProvince(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
-
Sets the PostalAddress state province.
- setStatus(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the deployment status.
- setSteps(int) - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
- 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
-
The street number to set for the postal addres.
- setStringFilter(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserAction
-
Set the search filter entered while searching for users.
- setStringFilter(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserToGroupAction
-
Set the search filter to search for groups.
- setStringFilter(String) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Set the search filter for filtering roles.
- setSubject(String) - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Sets the value of the subject property.
- setSystemDefined(boolean) - Method in interface com.softwareag.centrasite.api.csom.Role
-
Set whether the role is a system defined role or not.
- setTargets(Collection<Target>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the collection of targets for which the selected asset will be deployed.
- setTelephoneNumbers(Collection<TelephoneNumber>) - Method in interface com.softwareag.centrasite.api.csom.User
-
Sets the given collection of telephone numbers to the user.
- setTemplatePath(String) - Method in class com.softwareag.centrasite.api.privilege.service.EmailSettings
-
Sets the value of the templatePath property.
- setType(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
-
Set the PostalAddress type.
- setType(String) - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Sets the value of the type property.
- setURI(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Sets 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.
- setUser(boolean) - Method in class com.softwareag.centrasite.api.csom.action.InstanceLevelPermissionModel
-
Sets that the permission is applied to a user.
- setUser(boolean) - Method in class com.softwareag.centrasite.api.csom.action.PermissionModel
-
Sets that the permission is applied to a user.
- setUser(String) - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Sets the username or user ID of the user to be used for the deployment operation.
- setUserDefined(boolean) - Method in interface com.softwareag.centrasite.api.csom.Role
-
Set whether the role is user defined or not.
- setUserId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddUserToGroupAction
-
Set the user id for whom group memberships are given.
- setUserId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Set the user id to whom the roles should be assigned.
- setUserSelectedExportOptions(Collection<ExportOption>) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
-
Sets 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 the 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
-
Sets the element value.
- 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.
- setValue(String) - Method in class com.softwareag.centrasite.api.csom.runtime.EventDetailsAttribute
-
Sets the attribute value.
- setValues(List<?>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
-
Sets the parameter of the condition.
- setVirtualize(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
In case this is set to true, perform the virtualization without publishing and Virtualize
Action gets completed.
- setVisibleToEveryOne(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Controls the visibility of the API being published.
- setWebPage(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the organization's web page.
- setWebPage(String) - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Sets the web page address for the organization.
- SimpleAttribute - Interface in com.softwareag.centrasite.api.csom.attribute
-
SimpleAttribute used to handle/map the Slot Attributes of data types like
XS_BOOLEAN
XS_INTEGER
XS_DOUBLE
XS_DATE
etc..
- size() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchResult
-
Returns the size of the search result.
- SLOT_API_KEY_EXPIRATION_DATE - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
-
- 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
-
- start(BundleContext) - Method in class com.softwareag.centrasite.api.Activator
-
- start() - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
- stepMsg(String) - Method in class com.softwareag.centrasite.api.runtime.DeploymentCallback
-
- stop(BundleContext) - Method in class com.softwareag.centrasite.api.Activator
-
- 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
-
- sync() - Method in interface com.softwareag.centrasite.api.configurator.Configurator
-
Normally, the modification date of the DB file is checked for every property fetch.
- 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
-