- Gateway - Interface in com.softwareag.centrasite.api.csom
-
Gateway represents a Policy enforcement point (PEP) of
a particular type in CentraSite.
- GATEWAY_CONFIGURATION - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
-
- GatewayConfiguration - Class in com.softwareag.centrasite.api.csom.action
-
This bean represents an Gateway
.
- GatewayConfiguration() - Constructor for class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
- GatewayCreateUpdateResponse - Class in com.softwareag.centrasite.api.csom.action.runtime
-
This is the Response bean that is returned as a result of
getting all Gateways in CentraSite.see GatewayRESTClient.createGateway
and
GatewayRESTClient.deleteGateway
.
- GatewayCreateUpdateResponse() - Constructor for class com.softwareag.centrasite.api.csom.action.runtime.GatewayCreateUpdateResponse
-
- GatewayDeleteAction - Interface in com.softwareag.centrasite.api.csom.action
-
- GatewayGetResponse - Class in com.softwareag.centrasite.api.csom.action.runtime
-
This is the Response bean that is returned as a result of
getting all Gateways in CentraSite.see GatewayRESTClient.getGateways
and
GatewayRESTClient.getGateway(id)
.
- GatewayGetResponse() - Constructor for class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
- GatewayPublishAction - Interface in com.softwareag.centrasite.api.csom.action.runtime
-
- GatewayRESTClient - Interface in com.softwareag.centrasite.api.csom.runtime
-
This is the REST client that should be used to
invoke the Gateway service.
- Gateways - Class in com.softwareag.centrasite.api.csom.action
-
- Gateways() - Constructor for class com.softwareag.centrasite.api.csom.action.Gateways
-
- generateAndSendReport(ScheduledReport) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates and sends a BIRT report.
- generateAPIFile(RESTService) - Method in interface com.softwareag.centrasite.api.exporter.CentraSiteExporter
-
Generates the API file on the specific format and attach it to the given the REST API
- generateReport(String, String, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Generates a report in given format and returns the name of the temporary file.
- generateReport(OutputStream, String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on a report template, which is associated to the given Scheduled Report.
- generateReport(OutputStream, ScheduledReport) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on a report template, which is associated to the given Scheduled Report.
- generateReportAsExcel(String, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Generates a report in EXCEL format and returns the name of the temporary file.
- generateReportAsExcel(OutputStream, String, String, Locale, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on the given report template as EXCEL document.
- generateReportAsExcel(OutputStream, InputStream, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Generates a report based on the given report template as Excel document.
- generateReportAsHtml(String, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Returns the generated report as HTML.
- generateReportAsHtml(OutputStream, String, String, Locale, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on the given report template as HTML document.
- generateReportAsHtml(OutputStream, InputStream, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Generates a report based on the given report template as HTML document.
- generateReportAsPdf(String, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Generates a report in PDF format and returns the name of the temporary file.
- generateReportAsPdf(OutputStream, String, String, Locale, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on the given report template as PDF document.
- generateReportAsPdf(OutputStream, InputStream, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Generates a report based on the given report template as PDF document.
- generateReportAsWord(String, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Generates a report in WORD format and returns the name of the temporary file.
- generateReportAsWord(OutputStream, String, String, Locale, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Generates a report based on the given report template as WORD document.
- generateReportAsWord(OutputStream, InputStream, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Generates a report based on the given report template as Word document.
- generateSwaggerData(RESTService) - Method in interface com.softwareag.centrasite.api.exporter.CentraSiteExporter
-
Generates the Swagger data as JSON string from the given REST or Virtual REST service.
- generateWSDL20() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
(Re-)generate a WSDL20 file and update it to the service.
- GET_ALL_ASSET_TYPES - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
-
- GET_ORGANIZATIONS - Static variable in interface com.softwareag.centrasite.api.csom.search.PredefinedSearches
-
- GET_USER_DEFINED_TAXONOMIES - 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.
- getAccessTokenId() - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
Gets the API key.
- getAccessTokenType() - Method in enum com.softwareag.centrasite.api.csom.AccessTokenType
-
Gets the Access Token Type as a String.
- getAccessTokenType() - Method in enum com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest.AccessTokenType
-
Gets the Access Token Type as a String.
- 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.
- getActionCategory(String) - Static method in enum com.softwareag.centrasite.api.csom.action.ActionCategory
-
Returns the
ActionCategory
enum object for a given action category string value.
- getActionImportResources() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the REST resource assets representing the OData action imports.
- 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.
- getAlias() - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Gets the Runtime alias that has been deployed.
- getAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the list of aliases which are deployed.
- getAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Return the existing aliases for the selected service.
- getAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- 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 gateways.
- getAliasName() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets the Name of the Runtime alias.
- 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.
- getAliasType() - Method in interface com.softwareag.centrasite.api.csom.RuntimeAlias
-
Get the type of the Runtime alias.
- getAllActivities() - Method in interface com.softwareag.centrasite.api.activity.ActivityManager
-
Get all the activities available in the configuration file.
- getAllAliasesToDeploy() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesPublishAction
-
Gets the Collection of Runtime aliases to be published.
- getAllAliasesToDeploy() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesUnpublishAction
-
Gets the Collection of Runtime aliases to be unpublished.
- getAllAliasesTypes() - Method in interface com.softwareag.centrasite.api.activity.ManageGovernanceRulesActivity
-
Returns the List of all Runtime aliases that are present.
- getAllAliasTypes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets all the Alias Types available.
- getAllAssociatedServices() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Get Collection of Services that are associated to this Runtime alias.
- getAllAttributes(CentraSiteRegistryObjectType) - Method in interface com.softwareag.centrasite.api.csom.attribute.CSODefaultAttributes
-
- getAllAvailableGateways() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- getAllCommonAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Returns all the Common Attributes.
- getAllContextObjects() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Get all key-value pairs that are stored in this instance of CentraSiteSession.
- getAllDependentSchemas() - Method in interface com.softwareag.centrasite.api.csom.XMLSchema
-
Get the collection of schemas to which this XMLSchema is dependent on
- getAllEndpointsWithSandbox() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Gets all the endpoints for the REST/XML service with the corresponding Sandbox category.
- getAllGateways() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets
Collection
of
Gateway
for publish of the Runtime alias.
- getAllItems() - Method in interface com.softwareag.centrasite.api.configurator.Configurator
-
Gets all the Configuration items from the configuration XML.
- getAllMatchingResourcesPaths(Set<String>, List<Resource>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get all the resource paths by investigated the given resource list.
- getAllMethods() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Returns all methods of all resources of a REST/XML service.
- getAllNativeServiceIds() - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
- 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.
- getAllRuntimeAliases(List<String>) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Returns all the runtime aliases for the given type.
- getAllSandboxes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- getAllScopes() - Method in interface com.softwareag.centrasite.api.activity.ManageGovernanceRulesActivity
-
Returns the List of Scopes that are present.
- getAllSecureAliasAuthSchemes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets Authentication Schemes available for Secure alias.
- getAllStates() - Method in interface com.softwareag.centrasite.api.csom.LCM
-
Return all the states that exist in the LCM.
- getAllVirtualServiceIds() - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
- getAlreadyPublishedApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Returns the
Collection
of
APIPortal
instances to which an API is
already published.
- getAnyCounterpart(String) - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
Get the id of the virtual/native counterpart.
- 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.
- getApiKeyApprovalModel() - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Gets the API key approval models.
- getApiKeyHeader() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- getApiname() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse.APIPublishInfo
-
Gets the API name
- getApiName() - Method in class com.softwareag.centrasite.api.privilege.service.KeyCheckPolicy
-
Gets the value of the apiName property.
- getAPIPortalAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getAPIPortalDetailActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns the list of actions applicable for the API-Portal details page.
- getAPIPortalId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the API-Portal object id
- getAPIPortalIdsForDeletion() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- getApiPortalKey() - Method in class com.softwareag.centrasite.api.csom.Community
-
- getApiportaluuid() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Gets the UUID for the API-Portal
- getApplicableApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Returns the
Collection
of
APIPortal
objects that are accessible by the current logged in user for publish.
- getApplicableApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.portal.UnpublishFromPortalAction
-
Returns the
Collection
of
APIPortal
objects that are accessible by the current logged in user for unpublish.
- getApplicableAssets() - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
Gets the applicable assets matching the conditions
- getApplicableAttibutesForAlias() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets the Applicable Attributes for the Runtime alias.
- getApplicableAttributes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
return the list of attribute which can be used in the filter criteria.
- 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.
- getApplicableGateways() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
return the list of gateways which are available.
- getApplicableGateways() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Fetches all the gateways that are applicable.
- getApplicableGateways() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Fetches all the gateways that are applicable.
- getApplicableGateways() - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Gets all Gateways in all organization and, filters only gateways, to which user has edit permission to.
- 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.
- getApplicableOrganizations() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
Gets the applicable organizations for the logged in user.
- getApplicableReports() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Returns the collection of all applicable reports.
- getApplicableTypes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
list of types, can be render in the filter
- getApplicableTypes() - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
return the types to which this policy is applicable
- getApplicableUseCases() - Method in interface com.softwareag.centrasite.api.csom.action.AssetNavigatorAction
-
- 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.
- getArchiveImportLog() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
- getArchiveImportStatus() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Return the status of the archive import after processing is complete
- getArchiveOptions() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Return the specified import options
- getArchiveOptions() - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
- getAreaCode() - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
-
Gets the area code part of the Area Number.
- getAssetId() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getAssetName() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- getAssetNavigatorManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the ImpactAnalysis Manager.
- getAssetNavigatorUseCaseMap() - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorManager
-
- getAssetOptions() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Gets the asset options.
- getAssets() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Returns a list of newly created assets.
- getAssetType() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- getAssetTypeId() - Method in interface com.softwareag.centrasite.api.csom.action.AddAssetTypeAction
-
Get the id. of the asset type.
- getAssetTypes() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Returns the collection of top-level asset types.
- getAssetTypes() - Method in interface com.softwareag.centrasite.api.activity.ManageAssetTypesActivity
-
Returns all the asset types that the user can manage.
- getAssetTypesSearch() - Method in interface com.softwareag.centrasite.api.activity.ManageAssetTypesActivity
-
Obtains the
CSOSearch
instance of the saved search for this activity.
- getAssociatedAliases() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- 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.
- getAttributeDescription() - Method in interface com.softwareag.centrasite.api.csom.action.AddAttributeAction
-
Get the description of the asset type.
- getAttributeId() - Method in interface com.softwareag.centrasite.api.csom.action.AddAttributeAction
-
Get the id. of the asset 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.CSOComputedAttribute
-
Return the key of the attribute
- 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.
- getAttributeName() - Method in interface com.softwareag.centrasite.api.csom.action.AddAttributeAction
-
Get the name of the asset type.
- 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.
- getAvaliableEmailTempalte() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.NotifyConsumersAction
-
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.GatewayConfiguration
-
This is for Internal usage.
- 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.RuntimeAliasPublishRequest
-
Gets the base directory path to publish the Runtime alias.
- 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.
- getBindingCategory() - Method in interface com.softwareag.centrasite.api.csom.ServiceBinding
-
- getBriefDescription() - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Returns the brief description of the status code.
- 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.
- getCachedConfigurator(String) - Static method in class com.softwareag.centrasite.api.configurator.ConfiguratorFactory
-
Returns the cached configurator instances for the given key
- getCallerId() - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
Gets the UUID of the caller.
- getCanonicalPath() - Method in interface com.softwareag.centrasite.api.csom.Category
-
Gets the canonical path representation for this Category.
- getCategoryId() - Method in interface com.softwareag.centrasite.api.csom.action.AddCategoryAction
-
- getCentraSiteAlias() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the CentraSite alias of the API-Portal.
- getCentraSiteEndpoint() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the centrasiteEndpoint of the API-Portal
- getCentraSiteEndPoint() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
- getCentraSiteEndpoint() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Gets the centrasiteEndpoint of the Gateway
- 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.
- getCentraSitePassword() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- 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.
- getCentraSiteSwaggerExporter() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the Swagger2.0 exporter which generates the Swagger2.0 formatted file for a REST API
- getCentraSiteUser() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getCentrasiteUserId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The CentraSite Username provided during registration
- getCentraSiteUserId() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the centrasite user id from
APIPortal
which will be used for authenticating against the API-Portal.
- getCentrasiteUserPwd() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The password for the CentraSite user
- getCentrasitUserPwd() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the centrasite user password from passman manager.
- 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.
- getChartType() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- getChildData(AssetNavigatorJSON) - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorDataProvider
-
- 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.
- getChildQueriesWithDelim() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getChildQueryList() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getChildren() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- getCLLException() - Method in class com.softwareag.centrasite.api.common.exception.CllExtensionExceptionHelper
-
- 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.
- getCommunities() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Get all present communities of all registered API portals.
- getCommunities(APIPortal) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Get all present communities from API portal.
- getCommunities(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Get all present communities of all registered API portals.
- getCommunities(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Get and prepare the communities of the API portal.
- 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.
- getConnection() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns underlying connection associated with this session.
- getConsumableObjectsSearch() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Gets the CentraSite search object which can be used to obtain the consumable objects of the asset.
- getConsumableTypes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Gets the consumable types defined for the asset type.
- getConsumedAssets() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Obtains the assets which are consumed by this CentraSiteRegistryObject.
- getConsumer() - Method in interface com.softwareag.centrasite.api.csom.APIKey
-
Get the Consumer Id for this API key.
- getConsumer() - Method in interface com.softwareag.centrasite.api.csom.OAuth2Client
-
Get the Consumer Id for this OAuth Token.
- 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.
- getConsumerOrganization() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the consumer organization configured for
APIPortal
- getConsumerOrganizationId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the consumer organization configured for API-Portal.
- getConsumerOrganizationName() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the name of the consumer organization, where a dedicated consumer organization will be created with this name.
- getConsumerOrganizations() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the applicable consumer organizations for the logged in user.
- getConsumerOrganizations() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- 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 assets which are registered as consumers for this CentraSiteRegistryObject.
- getConsumingTypeDescription() - Method in interface com.softwareag.centrasite.api.csom.action.AddConsumingTypeAction
-
Get the consuming type description.
- getConsumingTypeId() - Method in interface com.softwareag.centrasite.api.csom.action.AddConsumingTypeAction
-
Get the consuming type id.
- getConsumingTypeName() - Method in interface com.softwareag.centrasite.api.csom.action.AddConsumingTypeAction
-
Get the consuming type name.
- getContent() - Method in interface com.softwareag.centrasite.api.csom.XMLSchema
-
Get the file content of the Schema asset
- 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
-
- 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.
- getCreateAssetName() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Get the name of the asset which was created.
- getCreatedObjectID() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Get the id of the Gateway that is created using this action
- getCredentials() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Gets the Base 64 encoded credentials for CentraSite
- getCSODefaultAttributes() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Get the CSO Default Attributes connected to this instance of CentraSiteSeassion
- getCsPassoword() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the CentraSite user's password for this Gateway
- getCsPassword() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- getCsUser() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the CentraSite user for this Gateway
- getCsUsername() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- 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.
- getCustomURL() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
- getDataProvider() - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorManager
-
- getDataType() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
-
Returns the data type of the CentraSite Object Attribute.
- getDataType() - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Returns the data type of the parameter.
- getDay() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the day on which the report is scheduled.
- getDayOfMonth() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the day of month on which the scheduled report shall be executed.
- getDays() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get all days on which the report is scheduled.
- 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.
- getDefaultSearch() - Method in interface com.softwareag.centrasite.api.activity.ManageGovernanceRulesActivity
-
return the Default Search which used used by activity
- getDefaultValue() - Method in interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
-
Returns the default value of the CentraSite Object Attribute, if present.
- getDefaultValue() - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Gets the default value of the parameter.
- getDefaultValues() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Get the default values for the Runtime alias.
- 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.
- getDeployableGateways() - Method in interface com.softwareag.centrasite.api.csom.RuntimeAlias
-
Get all Gateways to which Deployment is possible.
- getDeployedAliases() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getDeployedAssets() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getDeployedConsumers() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getDeployedGateways() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the list of gateways to deploy.
- getDeployedGateways(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return the list of gateways where given asset is deployed.
- getDeployedGateways() - Method in interface com.softwareag.centrasite.api.csom.RuntimeAlias
-
Get all gateways to which this alias is deployed.
- getDeployedServices() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getDeployedTargets(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
- 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 class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Gateway Deployment endpoint
- getDeploymentEndPoint() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Deprecated.
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.
- getDeploymentRESTClient(CentraSiteSession) - Method in class com.softwareag.centrasite.api.csom.runtime.RuntimeFactory
-
- getDeploymentRESTClient(String, String) - Method in class com.softwareag.centrasite.api.csom.runtime.RuntimeFactory
-
- 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 class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getDescription() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the description of the API-Portal.
- getDescription() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Gateway Description
- getDescription() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets the description of the Runtime alias.
- getDescription() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the description about the policy
- 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 class com.softwareag.centrasite.api.csom.Community
-
- getDescription() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Returns the file description.
- getDescription() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the description of the scheduled report.
- getDescription(Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the description of the scheduled report.
- getDescription() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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.
- getDetailedDescription() - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Returns the detailed description of the status code.
- 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
-
- getEditAssetTypeActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Gets the list of actions related to "Edit asset type activity".
- getEditPageURL() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
-
This method is used to return the context path of the edit view.
- getEditTaxonomyActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Gets the list of actions related to "Edit taxonomy activity".
- 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.
- getEncodedCentraSiteCred() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The Base64 encoded CentraSite credentials that is used to register CentraSite with API-Portal
- getEndPoint() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the end point of the webMethods API-Portal.
- getEndPoint() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the end point of the webMethods API-Portal.
- getEndpoint() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
Gets the Deployment Endpoint for the Gateway.
- 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.
- getEndpointSemantics() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Returns the
Collection
of
Category
objects which indicate the endpoint semantics.
- getEndpointSemantics() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Returns the
Collection
of
Category
objects which indicate the endpoint semantics.
- getEndpointsWithSandbox(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
For a given
Category
id, this method returns a collection of endpoint URIs which
are classified with the category id for the Sandbox.
- getEndpointUri() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Gets the endpoint URI for the service.
- getEndPointURIs() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Gets the endpoint URIs for the service.
- getEnforceActionCondition() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the enforce action condition.
- getEnforceCondition() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKey
-
Returns the enforcement condition applied for the runtime policies of a service
Enforcement condition is either AND or OR
- getEnforceCondition() - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Gets the enforcement condition (OR/AND)
- getEntityContainerName() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the OData entity container name.
- getEntitySetResources() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the REST resource assets representing the OData entity sets.
- 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.
- getExampleRequestContents() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example request contents and its request content types that are defined for the request request payload object.
- getExampleRequestFiles() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example request files and its request content types that are defined for the request request payload object.
- getExampleResponseContents() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example response contents and its response content types that are defined for the response payload object.
- getExampleResponseFiles() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example response files and its response content types that are defined for the response payload object.
- getExceptionMessage() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the Exception Message that the server throws.
- getExceptionString() - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Sets the Deployment Exception for the deployment of Runtime Alias on the Gateway.
- getExcludedCategories() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
-
Returns a collection of categories that are excluded from the search scope.
- getExecutionDate() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the date on which the report was executed for the last time.
- getExecutionDateInMilliseconds() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the date on which the report was executed for the last time in milliseconds.
- 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.
- getExportArchiveContent() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Return the specified export archive content
- getExportArchiveContent() - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
- 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.
- getExternalLinkKey() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Return the key of the JAXR external link
- 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.
- getExternalTomcatUrl() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The external TomcatURL used for communication with API-Portal
- getFailedActivityIds() - Method in interface com.softwareag.centrasite.api.activity.ActivityMenu
-
Returns list of failed activity Ids.
- getFailedAPIPortals() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Get the Collection of Failed API Portal responses.
- getFailedAPIPortals() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- getFailedAPIPortals() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesPublishAction
-
Gets the Collection of Failed API Portal responses.
- getFailedDeploymentMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
in case deployment failed, return the reason for the deployment failure
respective gateway
- getFailedDeploymentMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Returns the failed deployment status as key-value pair of (gateway, status message).
- getFailedDeploymentMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Returns the failed deployment status as key-value pair of (gateway, status message).
- getFailedDeploymentResponses() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesPublishAction
-
Gets the Collection of Failed Runtime Alias Publish Responses.
- getFailedDeploymentResponses() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesUnpublishAction
-
Gets the Collection of Failed Runtime Alias Unpublish Responses.
- getFailedDeploymentTargets() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the list of targets where deployment failed.
- getFailedMediatorMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- getFailedPortalMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Returns the failed deployment status as string.
- getFailedUnpublishMessages() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Returns the failed deployment status as key-value pair of (gateway, status message).
- getFile() - Method in interface com.softwareag.centrasite.api.csom.XMLSchema
-
Return the schema file backed by the XML Schema asset
- 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.
- getFormatMap() - Static method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorDateTimeFormatMapper
-
- getFrequency() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the frequency with which the report is executed (recurs every day(s)/week(s)/month(s)).
- getFunctionImportResources() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the REST resource assets representing the OData function imports.
- getGateway() - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Gets the Gateway to which the Runtime alias is deployed to.
- getGateway(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Populate the Gateway Object persisted using the given Unique Id.
- getGateway(String) - Method in interface com.softwareag.centrasite.api.csom.runtime.GatewayRESTClient
-
Gets a Gateway with a specified Id in CentraSite.
- getGatewayClient(CentraSiteSession) - Method in class com.softwareag.centrasite.api.csom.runtime.RuntimeFactory
-
- getGatewayClient(String, String) - Method in class com.softwareag.centrasite.api.csom.runtime.RuntimeFactory
-
- getGatewayConfiguration() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getGatewayForUndeploy() - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasPublishRequest
-
Gets a list of targets from which the aliases have to be unpublished.
- getGatewayListForUnpublish() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Fetches all the gateways that are applicable.
- getGateways() - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
All Gateways are stored here.
- getGateways() - Method in interface com.softwareag.centrasite.api.csom.runtime.GatewayRESTClient
-
Gets all Gateways that are present in CentraSite.
- getGateways() - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Gets the List of configured Gateways.
- getGatewaysConfiguration() - Method in class com.softwareag.centrasite.api.csom.action.Gateways
-
- getGatewayType() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- getGatewayType() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- 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.
- getHeaderParameters() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the header parameters that are defined for the response payload object.
- getHelpCenter() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Return the HelpCenter which is used to access the available HelpCenterTopics.
- getHostName() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- getHTTPMethod() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Retrieves the underlying HTTP method supported for the designated REST method.
- getHttpMethods() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the HTTP methods supported by this resource.
- getHTTPStatusCode() - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Gets the status code category of the status code that represents the corresponding W3C specified "HTTP Status Code" in CentraSite.
- 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 class com.softwareag.centrasite.api.csom.Community
-
- 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.
- getId() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the id. of the scheduled report.
- getIdentificationTokens() - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Gets the identification tokens.
- getImgSrc() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getImportedFileOriginalName() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- getImporterCallback() - Method in interface com.softwareag.centrasite.api.importer.CentraSiteImporter
-
Obtains the callback instance.
- getImporterDocuments() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Returns the collection of specification files that this REST service was imported from.
- getImporterStatus() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Obtains the current status of the importer.
- getImportLog() - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
Return the import log HTML file content as string
- 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.
- getInitialVirtualAssetName(List<String>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the name of the initial virtual service asset proposed to the user.
- 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.configurator.ConfiguratorFactory
-
Gets the configurator instance (System/Custom)
- getInstance(CentraSiteSession, User) - Static method in class com.softwareag.centrasite.api.configurator.ConfiguratorFactory
-
Gets the Configurator instance for the given connection/user
- getInstance(CentraSiteSession, Organization) - Static method in class com.softwareag.centrasite.api.configurator.ConfiguratorFactory
-
Gets the Configurator instance for the given Connection/Organization
- getInstance() - Static method in class com.softwareag.centrasite.api.csom.runtime.RuntimeFactory
-
Static Initializer to the Factory class
- 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.
- getInvokeURLMap() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
- 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.
- getKey() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the key of the Gateway
- 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.
- getKeyValueTypeString() - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- getLargeIcon() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Get the large icon of this type.
- getLargeIconAccessURL() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Return the access URL of the large icon of this type
- getLastModifiedTimeStamp() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
- 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.
- getLastValidParentNodeAssetId() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getLayer() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- getLocale() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the locale that is used when the report (template) is executed.
- 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.
- getLoggedInUserId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the logged in user to be used for consumer organization administrator.
- 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.
- getManageAssetTypesActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Gets the list of actions related to "Manage asset types activity".
- getManageGovernanceRulesActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Returns a list of actions applicable for Manage Governance Rules activity
- 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.
- getManageTaxonomiesActions() - Method in interface com.softwareag.centrasite.api.csom.action.CSOActionManager
-
Gets the list of actions related to "Manage taxonomies 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 class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Gets the Deployment Message for the deployment of Runtime Alias on the Gateway.
- 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.apiportal.APIPackageResponse.APIPublishInfo
-
Gets the execution message
- getMessage() - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Gets the value of the message property.
- getMessageFlow() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the MessageFlow based on the configured runtime policy actions
- 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.
- getMetadataDocument() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the metadata document of the OData service asset
- getMethods() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the HTTP method assets associated to the OData service.
- getMethods() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the list of methods defined on the resource
- 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.
- getMissingReferenceName() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Returns the name of the reference in the imported file.
- getMissingReferenceNames() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Obtains the name of the missing file references from the imported file.
- getMissingReferences() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Obtains the List
of missing references.
- getModeName() - Method in enum com.softwareag.centrasite.api.csom.action.ApprovalMode
-
Returns the string value for the enum.
- getName() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getName() - Method in enum com.softwareag.centrasite.api.csom.action.ActionCategory
-
Obtains the String value for the enum object.
- getName() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets name of the API-Portal.
- 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 class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the name of the Gateway
- 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 class com.softwareag.centrasite.api.csom.Community
-
- 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 enum com.softwareag.centrasite.api.csom.policy.PolicyType
-
Obtains the String value for the enum object.
- getName() - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- 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.ScheduledReport
-
Get the name of the scheduled report.
- getName(Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the name of the scheduled report.
- 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.
- getNativeCounterpart(String) - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
Get the id of the native counterpart from given virtual service asset type id.
- getNativeRegObject(CentraSiteObjectType, RegistryObject) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
- getNativeServiceAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getNativeXmlRestServiceIds() - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
- 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(boolean) - 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.
- getNestedResources() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the nested resources of the resource.
- getNewAssetId() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Returns the UUID (identifier key) of the newly created asset.
- getNewlyCreatedApplicationAsset() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
- getNewOrganization() - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- getNewOwner() - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- 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.
- getNextState() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
- 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.
- getNodeId() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- getObjectFromContext(Object) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Retrieve a key/value pair for being stored with this
CentaSiteSession instance
- getObjectName() - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- getObjects(List<String>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Populate the list of CentraSiteObjects persisted using the given identifiers.
- getObjectsForArchivePreview() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Return the top level objects from the specified export archive content for preview
- getObjectsForPreview() - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
Returns the top level objects of the provided export archive for preview
- getObtainedReferencePath() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
The path to the missing reference file.
- getOccurrence() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the occurrence of the scheduled report.
- getOccurrenceName(Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get localized occurrence name.
- getODataEntityType() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the OData entity type of the resource.
- getODataResourceType() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the OData resource type of the resource.
- getODataVersion() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the OData version of the OData service.
- 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.
- getOperations() - Method in interface com.softwareag.centrasite.api.csom.Service
-
Return the collection of
Operation
objects for this Service.
- getOperations() - Method in interface com.softwareag.centrasite.api.csom.ServiceBindingCategory
-
- 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
-
- getOptionsForAttach(String, boolean) - 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.
- getOrdinal() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the ordinal of a second value (day, week, month) on which the report is scheduled.
- getOrganization() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Organization name this Gateway belongs to.
- getOrganization() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the policy organization
- 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.
- getOrganization() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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.ManageGovernanceRulesActivity
-
Returns list of organization applicable to the current user in the context of manage governance
- 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.
- getOrganizationsForUser() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Gets the applicable provider organizations for the logged in user.
- 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 class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
- 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.
- getParameterDataType() - Method in enum com.softwareag.centrasite.api.csom.ParameterDataType
-
Obtains the String value for the enum object.
- getParameterDataType(String) - Static method in enum com.softwareag.centrasite.api.csom.ParameterDataType
-
Returns the
ParameterDataType
enum object for a given parameter Data type string value.
- getParameters() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Gets the parameters of the REST/XML Service
- getParameters() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the parameters of the resource
- getParameters() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Gets the parameters of the method which can be used during invocation of the method with appropriate values.
- getParameters() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the list of parameters of the scheduled report.
- 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.
- getParameterType() - Method in enum com.softwareag.centrasite.api.csom.ParameterType
-
Obtains the String value for the enum object.
- getParameterType(String) - Static method in enum com.softwareag.centrasite.api.csom.ParameterType
-
Returns the
ParameterType
enum object for a given parameter type string value.
- getParameterType() - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Returns the parameter type of the parameter object.
- 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 class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the password of the API-Portal which will be used for authenticating against the API-Portal.
- getPassword() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Gateway user's password
- getPassword() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getPassword() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Deprecated.
Gets The password of the Target's user to be used for the deployment operation.
- getPassword() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Returns the password to access the reference file if it is a URL.
- 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.
- getPath() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Retrieves the path value of the designated resource.
- 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.
- getPendingApprovers() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Returns the list of approvers for this approval flow.
- getPendingCount() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Gets the number of APIs pending to be processed.
- 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
-
- getPolicies(PolicyType) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Gets the policies of the given type
- getPolicy(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
get the Policy by given identifier
- getPolicyActionInstance(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Return an existing PolicyActionInstance based on the policyActionInstance identifier.
- getPolicyActions() - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
return the action instances associated to the policy
- 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.
- getPolicyActionTree() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
return the PolicyActionTree which used to render the Accordian (Populate
the actions which are applicable to all the types specified in the scope)
- getPolicyConstraints() - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
Return the constraints associated to the policy
- getPolicyMessage() - Method in class com.softwareag.centrasite.api.csom.action.portal.PublishToPortalCallback
-
Gets the message for the execution of publish/unpublish.
- getPolicyName() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the name of the policy
- getPolicyType() - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
return the type of the policy i.e DesignTime or RuntimePolicy
- getPort() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- getPortalAlias() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the portal alias of the API-Portal.
- getPortalInfo() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Gets the Publish information for a portal
- getPortalListforUnpublish() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
returns the list of already published API-Portals
- getPortalname() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse.PortalPublishInfo
-
Gets the API-Portal name
- getPortalPublishStatus() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- getPortalTenantId() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the portal tenant id of the API-Portal
- getPortalTenantId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the API-Portal tenant id
- getPortalTenantId() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Gets the portal tenant id of the API-Portal
- getPortalTenantId() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the portalTenantId
- getPortalUnpublishStatus() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- getPortalUserPwd() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the portal user password from passman manager.
- getPossibleValues() - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Retrieves the list of possible values for the designated parameter.
- 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.
- getPresentAPIs() - Method in class com.softwareag.centrasite.api.csom.Community
-
- 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.
- getProcessedCount() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Gets the number of APIs processed
- 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.
- getProfileDescription() - Method in interface com.softwareag.centrasite.api.csom.action.AddProfileAction
-
Get profile description.
- getProfileId() - Method in interface com.softwareag.centrasite.api.csom.action.AddProfileAction
-
Get profile id
- 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 interface com.softwareag.centrasite.api.csom.action.AddProfileAction
-
Get profile name.
- 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.ManageRuntimePolicyAction
-
get the progress of the deployment
- getProgress() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Returns number of deployment requests made which highlight the deployment progress.
- getProgress() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Returns number of deployment requests made which highlight the deployment progress.
- getProgress() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Returns number of deployment requests made which highlight the deployment progress.
- getPromptText() - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- getProtocol() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- getProviderOrganizationId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the organization to which the API-Portal will belongs to in CentraSite.
- getProviderOrganizations() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the applicable provider organizations for the logged in user.
- getProviderurl() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Returns the Provider URL value for CentraSite
- getPublishedAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- getPublishedAPIs() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the list of APIs that are published to the API-Portal.
- getPublishedAPIs() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse.PortalPublishInfo
-
Gets information about the Published APIs for a Portal
- getPublishReport() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
This returns a JSON string which explains the publish status.
- getPublishResultString() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Returns a string which sums up the result of publishing the selected APIs to the Portals.
- 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.
- getRecipient() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the recipient to whom the report will be sent.
- getRecipientDisplayName() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get recipient display name.
- getRecipientId() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the id. of the recipient to whom the report will be sent.
- getReferencedScopeId() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
-
Returns the referenced Scope Id from CSOTypeScope.
- getReferencePath() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Returns the reference path as referred by the imported file.
- getRefreshedData(AssetNavigatorJSON) - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorDataProvider
-
- 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.
- getRegisteredAPIPortalNames() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.DeletePolicyAction
-
- getRegisteredApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Returns the
Collection
of
APIPortal
objects which are registered with CentraSite.
- getRegisteredApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.portal.UnpublishFromPortalAction
-
Returns the
Collection
of
APIPortal
objects which are registered with CentraSite.
- getRegisteredApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
returns the list of registered API-Portals
- getRegisteredApiPortals() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
returns the list of registered API-Portals
- 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.
- getRelationShipValueMap(RelationShipAttribute) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Get the relationship attribute value as a map.
- getReport() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the report (template) to be triggered.
- getReportDataAsCsv(OutputStream, String, String, Locale, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Get the data of a report based on the given report template as comma separated values.
- getReportDataAsCsv(OutputStream, InputStream, Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Get the data of a report based on the given report template as comma separated values.
- getReportId() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Get the id. of the report (template) to be triggered.
- getReportingSearches() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
Fetches the collection of saved searches that are marked as report search.
- getReportParameters() - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Returns the parameter of a report.
- getReportParameters(String, Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Get a list of parameters for the given Scheduled Report.
- getReportParameters(InputStream) - Method in interface com.softwareag.centrasite.api.report.ReportEngine
-
Get a list of parameters for the given report template.
- getRequestContentTypes() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Retrieves the request content types defined in the designated REST method.
- getRequestContentTypes() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Retrieves the request content types defined in the designated REST method.
- getRequestDate() - Method in interface com.softwareag.centrasite.api.csom.ApprovalFlow
-
Gets the date of the approval request.
- getRequestedUser() - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Return the requested user of the registry object
- getRequestPayloadData(Long) - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeManager
-
This method returns the request pay load data.
- getRequestPayloads() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Gets request payloads
RESTPayload
of the method object.
- getRequestSchemaContents() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the request schema contents and its request content types that are defined for the request request payload object.
- getRequestSchemaFiles() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the request schema files and its request content types that are defined for the request request payload object.
- 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.
- getResources() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the list of all resources that are applicable to be virtualized.
- getResourcesForAliasSynchronization(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
For a given virtual alias, this method compares the native and virtual service resources
and gives a Map
indicating the state of synchronization between the two.
- getResourcesToRetain(List<RegistryEntry>) - Method in interface com.softwareag.centrasite.api.csom.RESTService
-
Determines the resources of the virtual service which could be retained during update, depending on the
native service resources which should be set.
- getResourceURLs() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Returns list of URLs using which the resource can be accessed.
- getResponseContentTypes() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Retrieves the response content types defined in the designated REST method.
- getResponseContentTypes() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Retrieves the response content types defined in the designated REST method.
- getResponsePayloadData(Long) - Method in interface com.softwareag.centrasite.api.csom.runtime.RuntimeManager
-
This method returns the response pay load data.
- getResponsePayloads() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Gets response payloads
RESTPayload
of the method object.
- getResponseSchemaContents() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the response schema contents and its response content types that are defined for the response payload object.
- getResponseSchemaFiles() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the response schema files and its response content types that are defined for the request response payload object.
- getRestServiceStack() - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Get the 'restServiceStack' value out from the 'DeploymentSettings' entry in centrasite.xml.
- getResult() - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayCreateUpdateResponse
-
Get the result of the operation
- getResult() - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
Get the Result of the get operation
- 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.
- getRetryCount() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the retryCount for contacting API-Portal
- getRetryCount() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- getRetryCount() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- getRetryCount() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the retryCount for contacting API-Portal
- getRetryInterval() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- getRetryIntervals() - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Gets the Retry Interval between each retry
- getRetryIntervals() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- getRetryIntervals() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the Retry Interval between each retry
- 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.
- getRootData(AssetNavigatorJSON) - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorDataProvider
-
- getRootNodeAssetId() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getRootOrganziation() - Method in interface com.softwareag.centrasite.api.csom.Organization
-
Gets the root organization.
- getRuntimeAliases() - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasPublishRequest
-
Gets the Collection of Runtime aliases to be published.
- getRuntimeAliases(List<String>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchManager
-
Returns a Collection of all Runtime Aliases for the given types
- 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.
- getSampleRequestsResponses() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Gets the sample requests and sample responses of the REST method.
- getSandbox() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
- getSandbox() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getSandboxClassification() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- getSandboxClassification() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Sand box classification key that this Gateway belongs to
- 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.
- getScheduledReport(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Get Scheduled Report specified by id.
- getScheduledReportManager() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the scheduled-report manager associated with this session.
- getScheduledReports() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Get a list of all Scheduled Reports.
- getScheduledReports(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReportManager
-
Get Scheduled Reports for a given recipient.
- getSchemaAccessPassword() - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Returns the access password for the schema if provided
- getSchemaAccessUrl(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the schema access URL for the resource.
- getSchemaAccessUsername() - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Retrieves the user name used for schema access authentication.
- getSchemaFileName() - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Gets the name of the schema file
- getSchemaId() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Get the UUID for the attached schema for the resource.
- getSchemaImports() - Method in interface com.softwareag.centrasite.api.csom.RESTService
-
Get map of schema imports
- getSchemaName() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectType
-
Retrieves the (schema) name of the type.
- getSchemaURL() - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Retrieves the URL of the schema file.
- 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
-
- getSecuritySchemeCategory() - Method in class com.softwareag.centrasite.api.csom.ApiSecurityScheme
-
Gets the security scheme category.
- getSecuritySchemeParameters() - Method in class com.softwareag.centrasite.api.csom.ApiSecurityScheme
-
Gets the additional security scheme parameters (if any).
- getSecuritySchemeReferenceName() - Method in class com.softwareag.centrasite.api.csom.ApiSecurityScheme
-
Gets the security scheme reference name to refer in the specification file (if any).
- getSecuritySchemes() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Returns the collection of security schemes applicable for this API.
- getSelectableResources() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Gets the list of all resources from a native service that are applicable to be virtualized.
- getSelectedAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Return the selected alias(es) for the native service.
- getSelectedAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Return the selected alias(es) for the native service.
- getSelectedAliases() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Return the selected alias(es) for the native service.
- getSelectedAliasType() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets the Type of the Runtime alias .
- getSelectedArchiveObjectKeys() - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Return the selected import object keys
- getSelectedConditions() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
list of conditions which is created by the user , in case of editing the
existing runtime policy, return the condition configured to the runtime
policy
- getSelectedEndPoint(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Return the selected end point for the given alias.
- getSelectedObjectKeys() - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
Get the appplied filter keys
- 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.
- getSelectedResources(List<Resource>, List<Resource>, List<String>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Extract the resource objects which have been selected by 'selectedResources' out from the total resource
list with respect to given set of 'selectableResources'.
- getSelectedSecureAuthScheme() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Gets the Secure Alias authentication scheme.
- getSelectedTypes() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
list of types which is selected by user , in case of editing the existing
runtime policy , return the types configured to the runtime policy
- getSelectedUnPublishAliasList() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- getSelectedUseCase() - Method in interface com.softwareag.centrasite.api.csom.action.AssetNavigatorAction
-
- getSelectionList() - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
Get a list of locale-specific labels with values for a selection list.
- getService() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the REST/XML service to which the resource is belongs to.
- getService(CentraSiteRegistryObject) - Method in interface com.softwareag.centrasite.api.csom.util.ProfileOverviewManager
-
Returns the native service of a given virtual service.
- getServiceBindings() - Method in interface com.softwareag.centrasite.api.csom.Service
-
Gets the bindings supported by the 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.
- getSingletonResources() - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Gets the REST resource assets representing the OData singletons.
- getSize() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getSkippedObjectsWithReason() - Method in interface com.softwareag.centrasite.api.csom.action.CSOAction
-
Gets the skipped objects with the reason to be skipped.
- getSmallIcon() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Get the small icon of this type.
- getSmallIconAccessURL() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Return the access URL of the small icon of this type
- 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
-
- getSpecificDataFromConfig(String, String, String, String) - Method in interface com.softwareag.centrasite.api.assetnavigator.AssetNavigatorManager
-
- 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 interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
- getStatus() - Method in class com.softwareag.centrasite.api.csom.action.portal.PublishToPortalCallback
-
Gets the status of execution for the publish/unpublish
- getStatus() - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Gets the deployment status.
- getStatus() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse.APIPublishInfo
-
- getStatus() - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Gets the execution status
- getStatusCode() - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayCreateUpdateResponse
-
Get the Status the operation
- getStatusCode() - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
Get the Status of the get operation
- getStatusCode() - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the status code object which represents the HTTP status code information of the REST response payload.
- getStatusCodes() - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
- 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.
- getSupportedMethods() - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the REST methods supported by the resource.
- 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 class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- 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.
- getTargetSandbox() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Deprecated.
Obtains the Sandbox classification for the target(if any).
- getTargetType() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Deprecated.
Gets the TargetType of the Target.
- getTaxonomies() - Method in interface com.softwareag.centrasite.api.activity.ManageTaxonomiesActivity
-
Returns all the taxonomies that the user can manage.
- getTaxonomiesSearch() - Method in interface com.softwareag.centrasite.api.activity.ManageTaxonomiesActivity
-
Obtains the
CSOSearch
instance of the saved search for this activity.
- 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.
- getTaxonomyId() - Method in interface com.softwareag.centrasite.api.csom.action.AddTaxonomyAction
-
Get the id. of the taxonomy.
- 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.
- getTokenRefreshInterval() - Method in interface com.softwareag.centrasite.api.csom.OAuth2Client
-
Returns Refresh Interval for OAuth2 Client Object in seconds.
- getTokenType() - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
- 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.
- getTopLevelConsumableTypes() - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Returns the collection of top level consumable asset types defined for the selected objects for this action.
- 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.
- getTruncationLimit() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getType() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getType() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the type of the gateway.
- 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.CentraSiteRegistryObject
-
Return the type of this registry object
- 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 class com.softwareag.centrasite.api.csom.ReportParameter
-
- 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.
- getTypeName() - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- 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() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Fetches a collection of all types.
- getTypes(String) - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
Fetches a collection of types that are containing the given keyword.
- getTypeSupportedSpecifications() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteRegistryObjectType
-
Obtains the collection of specifications supported by this type.
- getUddiKey() - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- 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.MergeUnpublishAction
-
- getUnPublishAliasList() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Gets the aliases which have to be unpublished from the gateways.
- getUnpublishReport() - Method in interface com.softwareag.centrasite.api.csom.action.portal.UnpublishFromPortalAction
-
This returns a JSON string which explains the unpublish status.
- getUnpublishReport() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
This returns a JSON string which explains the unpublish status.
- 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.
- getUnsupportedHttpMethods() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get the HTTP methods (as IDs of their Categories) which are not supported of the particular service.
- getUnublishResultString() - Method in interface com.softwareag.centrasite.api.csom.action.portal.UnpublishFromPortalAction
-
Returns a string which sums up the result of unpublishinig the selected APIs from the Portals.
- getUnublishResultString() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Returns a string which sums up the result of unpublishinig the selected APIs from the Portals.
- getURI() - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Returns the URI where the file is stored.
- getURI() - Method in interface com.softwareag.centrasite.api.csom.search.CSOLink
-
Returns a URI based on the link type and link parameters.
- getURI(CSOLink) - Method in interface com.softwareag.centrasite.api.session.CSOUriGenerator
-
Generates a link for the given CSOLink object.
- getURIGenerator() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Returns the CSOUriGenerator for this session.
- getUrl() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getUseCase() - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- getUser() - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Get the Gateway User.i.e Username of the Gateway instance
- getUser() - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- getUser() - Method in interface com.softwareag.centrasite.api.csom.runtime.Target
-
Deprecated.
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.
- getUserId() - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Gets the user id of the API-Portal which will be used for authenticating against the API-Portal.
- getUserName() - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Gets the user id from
APIPortal
which will be used for authenticating against the API-Portal.
- getUsername() - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Returns the username to access the reference file if it is a URL.
- 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.
- getUserVersion() - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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 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.ReportParameter
-
- 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 class com.softwareag.centrasite.api.csom.ReportParameter
-
- getValues() - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchCondition
-
Returns the parameters of the condition.
- getVersion() - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- getVersion() - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
get the policy version
- getViewPageURL() - Method in interface com.softwareag.centrasite.api.csom.type.ComputedProfile
-
This method use to return the context path of the Details view.
- getVirtualAllSeriveAttributes() - Method in interface com.softwareag.centrasite.api.csom.type.CentraSiteObjectTypeManager
-
- getVirtualAssetTypes() - Method in interface com.softwareag.centrasite.api.activity.ManageGovernanceRulesActivity
-
Returns list of virtual types which are applicable to run-time policies
Currently run-time policies are supported only for Virtual Service, Virtual REST Service and Virtual XML Service
- getVirtualCounterpart(String) - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
Get the id of the virtual counterpart from given native service asset type id.
- getVirtualizationService() - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Gets the virtualization service for this session.
- getVirtualServiceId() - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Return the VirtualService ID of the native service just virtualized
- getVirtualTypeName() - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Get the virtual type name for a native service.
- getVirtualXmlRestServiceIds() - Static method in class com.softwareag.centrasite.api.csom.ServiceUtil
-
- 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.
- save() - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Saves the scheduled report to the 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.action.ExtendedSaveAction
-
Save the list of CentraSiteObjects to the registry
- saveObjects(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteObjectManager
-
Persists the given collection of CentraSiteObjects.
- saveScheduledReport(ScheduledReport) - Method in interface com.softwareag.centrasite.api.activity.GlobalReportActivity
-
- 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
-
- ScheduledReport - Interface in com.softwareag.centrasite.api.csom
-
Represents a Scheduled Report.
- ScheduledReportHandler - Interface in com.softwareag.centrasite.api.report
-
Handles a Scheduled Report.
- ScheduledReportManager - Interface in com.softwareag.centrasite.api.csom
-
- 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
-
- ServiceBinding - Interface in com.softwareag.centrasite.api.csom
-
- ServiceBindingCategory - Interface in com.softwareag.centrasite.api.csom
-
- ServiceUtil - Class in com.softwareag.centrasite.api.csom
-
- ServiceUtil() - Constructor for class com.softwareag.centrasite.api.csom.ServiceUtil
-
- setAccessTokenId(String) - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
Sets the API key.
- setActivate(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the flag to true in case of policy need base created & change the
state of the policy to Production, so policy applied to the newly
published applicable assets
- 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.
- setAlias(RuntimeAlias) - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Sets the Runtime alias that has been deployed.
- setAliasesToDeploy(Collection<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesPublishAction
-
Sets the Collection of Runtime aliases to be published.
- setAliasesToDeploy(Collection<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesUnpublishAction
-
Sets the Collection of Runtime aliases to be unpublished.
- setAliasListForUnDeploy(Map<CentraSiteRegistryObject, List<Gateway>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the alias list for undeploying.
- setAliasListForUnpublish(Map<CentraSiteRegistryObject, List<Gateway>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- setAliasName(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the Name of the Runtime alias.
- 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.
- setAllGateways(List<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets
Collection
of
Gateway
for publish of the Runtime alias.
- setAllSecureAliasAuthSchemes(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets Authentication Schemes for Secure alias.
- 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.
- setApiKeyApprovalModel(List<APIKeyApprovalModel>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.ActivateAPIKeyModel
-
Sets the API key approval models.
- setApiKeyHeader(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- 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.
- setAPIPortalConfiguration(APIPortalConfiguration) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- setAPIPortalId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the API-Portal object id
- setAPIPortalIdsForDeletion(Collection<String>) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- setApiPortalKey(String) - Method in class com.softwareag.centrasite.api.csom.Community
-
- setApiportaluuid(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Sets the UUID for the API-Portal
- setApplicableAttributesForAlias(Map) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the Applicable Attributes for the Runtime alias.
- setApplicableTypes(Collection<CentraSiteRegistryObjectType>) - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
Sets the types to which this policy is applicable
- 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.
- setArchiveImport(boolean) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Set to true if export archive needs to be imported
- setArchiveOptions(ImportArchiveOptions) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
- setArchiveOptions(ImportArchiveOptions) - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
- setAreaCode(String) - Method in class com.softwareag.centrasite.api.csom.TelephoneNumber
-
Sets the area code part of the Area Number.
- setArray(boolean) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Sets the multiplicity characteristic of the parameter.
- setAssetId(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setAssetName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
Sets the name for the asset.
- setAssetName(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- setAssetOptions(CentraSiteAssetOptions) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Sets the asset options.
- setAssetSpecific(boolean) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setAssetType(CentraSiteObjectType) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Sets the applicable asset type for the policy action instance.
- setAssetType(CentraSiteObjectType) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionTemplate
-
Sets the asset type.
- setAssetType(CentraSiteRegistryObjectType) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- setAssetTypeDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAssetTypeAction
-
Set the description of the asset type.
- setAssetTypeName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAssetTypeAction
-
Set the name of 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.
- setAttributeDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAttributeAction
-
Set the description of the asset type.
- setAttributeName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAttributeAction
-
Set the name of the asset type.
- 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.GatewayConfiguration
-
This is for Internal usage.
- 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.RuntimeAliasPublishRequest
-
Sets the base directory path to publish the Runtime alias to.
- setBaseDir(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.UnPublishRequest
-
Sets the base directory path to unpublish from.
- setBriefDescription(String) - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Sets the brief description for status code.
- setBrowsable(boolean) - Method in interface com.softwareag.centrasite.api.csom.Taxonomy
-
Marks a Taxonomy as browsable.
- setCallerId(String) - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
Sets the caller's UUID.
- setCategoryDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddCategoryAction
-
- setCategoryName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddCategoryAction
-
- setCentraSiteAlias(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the alias of the CentraSite, which will be used by the API-Portal to delegate API Key requests/renewals/revokes from API-Portal users to CentraSite.
- setCentraSiteEndPoint(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
- setCentraSitePassword(String) - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- setCentraSiteUser(String) - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- setCentraSiteUserId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets CentraSite user id of the API-Portal.
- setCentrasiteUserId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The username for CentraSite
- setCentraSiteUserId(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the centrasite user id to
APIPortal
which will be used for authenticating against the API-Portal.
- setCentraSiteUserPwd(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets CentraSite user password of the API-Portal.
- setCentrasiteUserPwd(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
The password value to set for the user
- setCentraSiteUserPwd(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the centrasite user password to
APIPortal
which will be used for authenticating against the API-Portal.
- 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.
- setChartType(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setChildQueriesWithDelim(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setChildren(List<AssetNavigatorJSON>) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.action.runtime.ManageRuntimePolicyAction
-
construct the CSOSearchCondition based on the additional filter criteria
- setConditions(Collection<CSOSearchCondition>) - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
Sets the constraints associated to the policy
- 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.
- setConsumerObjects(Collection<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the consumer objects to be registered as consumers of the asset
- setConsumerOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the consumer organization to
APIPortal
where the webMethods API-Portal users will be created in CentraSite when the user requests API key for an API.
- setConsumerOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the consumer organization to
APIPortal
where the webMethods API-Portal users will be created in CentraSite when the user requests API key for an API.
- setConsumerOrganizationId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the consumer organization to API-Portal, where the webMethods API-Portal users will be created in CentraSite when the user requests API key for an API.
- setConsumerOrganizationName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the name of the consumer organization that is going to be created and dedicated for the API-Portal.
- setConsumerOrganizationName(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the name of the consumer organization that is going to be created and dedicated for the API-Portal.
- setConsumingTypeDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddConsumingTypeAction
-
Set the consuming type description.
- setConsumingTypeName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddConsumingTypeAction
-
Set the consuming type 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
-
- 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.
- setCreate(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
in case user set the create policy set true and perform the
executeNextStep policy get created and action state changes to completed
- 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.
- setCredentials(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Sets the Base 64 encoded credentials for CentraSite
- setCsPassoword(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the CentraSite user's password for this Gateway
- setCsPassword(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setCsUser(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the CentraSite user for this Gateway
- setCsUsername(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setCustomURL(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
- setDataType(String) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Sets the data type of the parameter.
- setDay(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the day on which the report is scheduled.
- setDayOfMonth(int) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the day of month on which the scheduled report shall be executed.
- setDays(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set specified list of days.
- setDeactivate(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets whether the API key should be deactivated.
- setDedicatedConsumerOrganization(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets whether it is required to create a dedicated consumer organization for the API-Portal.
- setDedicatedConsumerOrganization(boolean) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets whether it is required to create a dedicated consumer organization for the API-Portal.
- setDefaultUserCredentials(String, String) - Method in interface com.softwareag.centrasite.api.runtime.DeploymentManager
-
Set the default userId and password to be used if gateway does not contain user credentials
This will be used during deployment
- setDefaultValue(String) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Sets the default value of the parameter.
- setDefaultValues(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the default values for the Alias.
- 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(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Gateway Deployment endpoint
- setDeprecated(boolean) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
- 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 class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets description of the API-Portal.
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the organization's description.
- setDescription(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the description of the API-portal.
- setDescription(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Description of the Gateway.
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the description of the Runtime alias .
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the description of the policy
- 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 class com.softwareag.centrasite.api.csom.Community
-
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.repository.CentraSiteFile
-
Set the description for the file.
- setDescription(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the description of the scheduled report.
- setDescription(String, Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the description of the scheduled report.
- setDescription(InternationalString) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the description of the scheduled report.
- setDescription(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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.
- setDetailedDescription(String) - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Sets the detailed description for the status code.
- 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.
- setDummyNode(boolean) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setEdit(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets whether the action is editing an already existing Runtime alias.
- 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.
- setEmailBody(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.NotifyConsumersAction
-
- 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.
- setEmailFormat(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.NotifyConsumersAction
-
- 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.
- setEmailSubject(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.NotifyConsumersAction
-
- 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.
- setEmailTemplate(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.NotifyConsumersAction
-
- 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.
- setEncodedCentraSiteCred(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the Base 64 encoded CentraSite credentials
- setEndpoint(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the end point of the webMethods API-Portal to
APIPortal
- setEndPoint(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the end point of the webMethods API-Portal
- setEndpoint(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the end point of the webMethods API-Portal to
APIPortal
- setEndpoint(String) - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
Sets the Deployment Endpoint for the Gateway.
- 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.
- setEndpointsWithSandbox(Map<String, Category>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the endpoint URIs for the REST/XML service and also classifies each endpoint to a Sandbox taxonomy.
- setEndpointUri(String) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
- setEndPointURIs(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the endpoint URIs 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.
- setEnforceCondition(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the enforcement condition (OR/AND)
- setEnforcementValues(Map<String, Object>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
Sets the given enforcement values.
- setEntityContainerName(String) - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Sets the OData entity container name.
- 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.
- setExampleRequestContents(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the example request content (as a plain text) along with its request content type information to the request payload object.
- setExampleRequestFiles(Map<CentraSiteFile, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example request files and its request content types that are defined for the request request payload object.
- setExampleResponseContents(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the example response content (as a plain text) along with its response content type information to the response payload object.
- setExampleResponseFiles(Map<CentraSiteFile, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Gets the example response files and its response content types that are defined for the response payload object.
- setExceptionMessage(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.DeploymentResponse
-
Sets the Exception Message that the server throws.
- setExceptionString(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Gets the Deployment Exception for the deployment of Runtime Alias on the Gateway.
- 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.
- setExecutionDate(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the execution date of the scheduled report in xs:date format (YYYY-MM-DD[+|-hh:mm], e.g. 2014-12-31+01:00).
- 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.
- setExportArchiveContent(InputStream) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Set the export archive content as InputStream
- setExportArchiveContent(InputStream) - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
- 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.
- setExternalTomcatUrl(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the value of the external Tomcat URL
- 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.
- setForceUnpublish(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesUnpublishAction
-
Sets the Force Unpublish flag to allow API-Portals to be forcefully unpublished from
CentraSite irrespective of the API-Portal's availability.
- setFrequency(int) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the frequency with which the report is executed (recurs every day(s)/week(s)/month(s)).
- setFromBulk(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- setFromBulk(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- setFromGlobalPolicy(boolean) - Method in interface com.softwareag.centrasite.api.csom.policy.CentraSitePolicyActionInstance
-
Sets if the policy action instance is from a global policy.
- setGateway(Gateway) - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Sets the Gateway to which the Runtime alias is deployed to.
- setGatewayConfiguration(GatewayConfiguration) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Set the Gateway Configuration bean that has all information about the Gateway.
- setGatewayForUndeploy(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasPublishRequest
-
Sets the gateway Id from which the aliases have to be unpublished.
- setGatewayListForUnpublish(List<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Sets the collection of gateways for which the selected asset will be deployed.
- setGateways(Gateways) - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
Set the Gateways
- setGateways(Collection<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
the gateways which are selected for by the user to redeploy the assets
which matches the policy contraints.
- setGateways(Collection<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Sets the collection of gateways for which the selected asset will be deployed.
- setGateways(Collection<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the collection of gateways for which the selected asset will be deployed.
- setGatewaysConfiguration(Collection<GatewayConfiguration>) - Method in class com.softwareag.centrasite.api.csom.action.Gateways
-
- setGatewayType(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
- setGlobal(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the flag to true in case of policy applicable to all the
organizations
- setGlobal(boolean) - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
set true, in case of policy is global
- 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.
- setHasChild(boolean) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setHeaderParameters(Collection<RESTParameter>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets list of parameters of type 'Header' which can be used in the REST response payload.
- setHidden(boolean) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- setHostName(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setHTTPMethod(Category) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Defines the category of the HTTP method in accordance to the W3C specification.
- setHttpMethods(Set<String>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
- setHttpServletRequest(HttpServletRequest) - Method in interface com.softwareag.centrasite.api.session.CentraSiteSession
-
Sets the HTTP servlet request for this session.
- setHTTPStatusCode(Category) - Method in interface com.softwareag.centrasite.api.csom.RESTStatusCode
-
Sets the category for the status code.
- setId(String) - Method in class com.softwareag.centrasite.api.csom.Community
-
- 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.
- setImgSrc(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setImportedFileOriginalName(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- setImporterCallback(CentraSiteImporterCallback) - Method in interface com.softwareag.centrasite.api.importer.CentraSiteImporter
-
Sets the callback for the importer.
- setImporterDocuments(Category, LinkedHashMap<String, String>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the document(s) which were imported to create a REST API in CentraSite.
- setImporterStatus(CentraSiteImporterStatus) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Sets the current status of the importer.
- setImportGroup(boolean) - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- 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.
- setInvokeURL(String) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Checks if the given alias name is NCName valid else replace with '_' character.
- 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.
- setKey(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the key of the Gateway.
- 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.
- setLastValidParentNodeAssetId(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setLayer(Integer) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- setLocale(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the locale that is used when the report (template) is executed.
- setLocalName(String) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set the Local-Name Classification of this RegistryObject.
- setLoggedInUserId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Set the current logged in user; usually the API-Portal Administrator user who is creating the portal.
- 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.csom.action.runtime.RuntimeAliasesDeploymentResponse
-
Sets the Deployment Message for the deployment of Runtime Alias on the Gateway.
- 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.runtime.ManageRuntimePolicyAction
-
set the MessageFlow constructed based on the configured runtime policy
actions
- setMessageFlow(MessageFlow) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Set the MessageFlow
constructed with the user selected policy Actions.
- setMetadataDocument(CentraSiteRepositoryFile) - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Assigns a single metadata document to the OData service asset
- setMethods(Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Sets the HTTP method assets associated to the OData service.
- setMethods(Collection<RESTMethod>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Defines a set of methods for the designated resource.
- setMiddleName(String) - Method in interface com.softwareag.centrasite.api.csom.User
-
Sets Middle Name for the current user.
- setMissingReferenceName(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Sets the name of the reference missing in the imported file.
- setMissingReferences(List<CentraSiteImporterReference>) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Sets the missing references.
- setMultiValue(boolean) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- 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 class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets name of the API-Portal
- setName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddOrganizationAction
-
Set the organization's name.
- setName(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets name of the API-Portal.
- setName(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the name of the Gateway
- 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 class com.softwareag.centrasite.api.csom.Community
-
- setName(String) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- 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.ScheduledReport
-
Set the name of the scheduled report.
- setName(String, Locale) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the name of the scheduled report.
- setName(InternationalString) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the name of the scheduled report.
- 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.
- setNestedResource(Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Gets the nested resources of the resource.
- setNewListName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddToListAction
-
Sets the objects to a given new list.
- setNewOrganization(Organization) - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- setNewOwner(User) - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- setNextState(ActionStateEnum) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
- setNodeId(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- setObjectName(String) - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- 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.
- setObtainedReferencePath(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Sets the path to the missing reference file.
- setOccurrence(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the occurrence of the scheduled report.
- setODataEntityType(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Sets the OData entity type of the resource.
- setODataResourceType(Category) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Sets the OData resource type of the resource.
- setODataVersion(Category) - Method in interface com.softwareag.centrasite.api.csom.ODataService
-
Sets the OData version of the OData service.
- 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.
- setOrdinal(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the ordinal of a second value (day, week, month) on which the report is scheduled.
- setOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the submitting organization for
APIPortal
.
- setOrganization(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Organization name this Gateway belongs to.
- setOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
organization to which the policy is applicable
in case of the organization not specified, Administrator organization
assigned as submitting organization
- setOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set the belonging Organization of the CentraSiteRegistryObject.
- setOrganization(Organization) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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.
- setOverwriteExistingObjects(boolean) - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- setOwner(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
- 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.
- setParameters(Collection<RESTParameter>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the list of parameters on the REST/XML Service
- setParameters(Collection<RESTParameter>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Defines a collection of parameters for the designated resource.
- setParameters(Collection<RESTParameter>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Sets list of parameters which can be used for the method invocation with appropriate values.
- setParameters(Collection<ReportParameter>) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the list of parameters of the scheduled report.
- setParameterType(String) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Sets the parameter type of the parameter object.
- setParentId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddCategoryAction
-
- 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.action.AddAPIPortalAction
-
Sets the password to
APIPortal
which will be used for authenticating against the API-Portal.
- setPassword(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the password of the API-Portal which will be used for authenticating against the API-Portal.
- setPassword(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Gateway user's password
- setPassword(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the password to
APIPortal
which will be used for authenticating against the API-Portal.
- setPassword(String) - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- setPassword(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Sets the password to access the reference file if it is a URL.
- setPassword(String) - Method in class com.softwareag.centrasite.api.privilege.onboarding.OnboardingRequest
-
Sets the password for the user.
- setPath(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Defines a path value for the designated resource.
- setPathToMissingReference(String, String, String, String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterCallback
-
Sets the path to the missing reference for the given missing reference name.
- 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.
- setPendingCount(int) - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Sets the number of APIs pending to be processed.
- 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.
- setPolicyActions(Collection<CentraSitePolicyActionInstance>) - Method in interface com.softwareag.centrasite.api.csom.policy.Policy
-
set the applicable action instances associated to the policy
- setPolicyName(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the name for the policy
- setPort(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setPortalAlias(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the unique alias of the API-Portal which will be used for API-Portal identification in CentraSite.
- setPortalInfo(ArrayList<APIPackageResponse.PortalPublishInfo>) - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Sets the Publish information for a portal
- setPortalTenantId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets Portal tenant id of the API-Portal.
- setPortalTenantId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the API-Portal tenant id
- setPortalTenantId(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Sets Portal tenant id of the API-Portal.
- setPortalTenantId(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the portalTenantId
- setPossibleValues(Collection<String>) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Defines the list of possible values for the designated parameter.
- 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
.
- setPresentAPIs(Collection<String>) - Method in class com.softwareag.centrasite.api.csom.Community
-
- setPreviewComplete(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.ExportAction
-
Used to set to true in case the preview options are finalized.
- setPrevious(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets whether to execute the previous state of the Action.
- setPrevious(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Sets whether to execute the previous state of the Action.
- setPrevious(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Sets whether to execute the previous state of the Action.
- 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.
- setProcessedCount(int) - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Sets the number of APIs processed
- setProfileDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddProfileAction
-
Set profile description.
- setProfileId(String) - Method in class com.softwareag.centrasite.api.csom.action.ProfilePermissionModel
-
Sets the profile id.
- setProfileName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddProfileAction
-
Set profile name.
- 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.
- setPromptText(String) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- 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.
- setProtected(boolean) - Method in class com.softwareag.centrasite.api.configurator.ConfiguratorItem
-
Set whether the element should be protected or not.
- setProtocol(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setProviderOrganizationId(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the organization to API-Portal to which the API-Portal will belongs to in CentraSite.
- setProviderurl(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
Sets the Provider URL value
- setPublish(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Set whether the CentraSite should be registered with API-Portal along with the save
- setPublish(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageGatewayAction
-
Sets whether the save of the Gateway should be continued by a publish of CentraSite details to the Gateway.
- setPublish(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets whether save of Runtime alias should be accompanished with a publish.
- setPublishedAPIs(ArrayList<APIPackageResponse.APIPublishInfo>) - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse.PortalPublishInfo
-
Sets the information about the published APIs for a Portal
- 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.
- setRecipient(User) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the recipient to whom the report will be sent.
- setRecipientId(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the id. of the recipient to whom the report will be sent.
- setReferencedScopeId(String) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearchScope
-
Sets the reference Scope Id on CSOTypeScope.
- setReferencePath(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Sets the reference path as referred by the imported file.
- setRefreshLimit(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.APIKeyConfiguration
-
Sets the number of times the API key can be refreshed.
- setRegistered(boolean) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- 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.
- setRelationShipValueMap(RelationShipAttribute, Map<CentraSiteRegistryObject, Map<String, Collection<Object>>>) - Method in interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
-
Set the relationship attribute value using a map whose key is the target
CentraSiteRegistryObject
and value is the map of additional information that needs to be stored as part of the particular target relationship
- setRemoveLists(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.RemoveFromListAction
-
Sets the "lists" from which the object(s) should be removed.
- setRenderAsPdf(boolean) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the rendering format of the report.
- setReport(RegistryObject) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the report (template) to be triggered.
- setReportId(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set the id. of the report (template) to be triggered.
- setRequestContentTypes(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Defines the request content types that are supported by the designated REST method
- setRequestContentTypes(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Defines the request content types that are supported by the designated REST method
- setRequestPayloads(Collection<RESTPayload>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
- setRequestSchemaContents(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the request schema content (as a plain text) along with its request content type information to the request payload object.
- setRequestSchemaFiles(Map<CentraSiteFile, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the request schema files along with request content type information to the
RESTPayload
- setRequired(boolean) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- setRequired(boolean) - Method in interface com.softwareag.centrasite.api.csom.RESTParameter
-
Sets the mandatoriness of the parameter.
- setReread(boolean) - Method in class com.softwareag.centrasite.api.csom.action.runtime.PublishRequest
-
Sets whether assets to be re-read on server side
- setResources(List<Resource>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Set the resources for the service.
- setResourcesForAliasSynchronization(Set<String>, Set<String>) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
This method is called to set the resources to retain with the Virtual service and
the resources to synchronize from the native service.
- setResponseContentTypes(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Defines the response content types that are supported by the designated REST method.
- setResponseContentTypes(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Defines the response content types that are supported by the designated REST method.
- setResponsePayloads(Collection<RESTPayload>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
- setResponseSchemaContents(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the response schema content (as a plain text) along with its response content type information to the response payload object.
- setResponseSchemaFiles(Map<CentraSiteFile, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the response schema files along with response content type information to the
RESTPayload
- setResult(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayCreateUpdateResponse
-
Set the result of the operation.
- setResult(String) - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
Set the Result of the get operation
- setResultAttributes(Collection<CentraSiteObjectAttribute>) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
Sets the result attributes with the search object.
- setRetainLCMState(boolean) - Method in class com.softwareag.centrasite.api.activity.ImportArchiveOptions
-
- setRetryCount(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets retry count for reaching API-Portal.
- setRetryCount(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- setRetryCount(Integer) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- setRetryCount(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets retry count for reaching API-Portal.
- setRetryEnabled(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets whether the Retry Mechanism is enabled or not
- setRetryEnabled(boolean) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- setRetryEnabled(boolean) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets whether the Retry Mechanism is enabled or not
- setRetryInterval(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- setRetryIntervals(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the Retry Intervals between each retry
- setRetryIntervals(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- setRetryIntervals(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the Retry Intervals between each retry
- setReuse(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
If reuse is true, just reuse the existing schema graph if present.
- 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.
- setRootNodeAssetId(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setRuntimeAliases(Collection<String>) - Method in class com.softwareag.centrasite.api.csom.action.runtime.RuntimeAliasPublishRequest
-
Sets the Collection of Runtime aliases to be published.
- 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.
- setSampleRequestsResponses(Map<String, Set<String>>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
Sets the sample requests and sample responses for the REST method.
- setSandbox(Category) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
- setSandbox(Category) - Method in interface com.softwareag.centrasite.api.csom.Gateway
-
- setSandboxClassification(String) - Method in class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
- setSandboxClassification(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Sand box classification key that this Gateway belongs to
- setSchemaAccessPassword(String) - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Sets the password required to obtain the schema files if they are uploaded from a URL.
- setSchemaAccessUsername(String) - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Sets the user name to authenticate the schema file access.
- setSchemaFileName(String) - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Sets xml schema file name
- setSchemaId(String) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Set the schema id for the resource.
- setSchemaImports(Map<String, String>) - Method in interface com.softwareag.centrasite.api.csom.RESTService
-
Define the schema imports for the REST service
- setSchemaOverWrite(boolean) - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Sets the option to overwrite existing schema if any.
- setSchemaURL(String) - Method in interface com.softwareag.centrasite.api.csom.RESTResourceSchema
-
Sets URL of the schema
- 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.
- setSecuritySchemeParameters(String) - Method in class com.softwareag.centrasite.api.csom.ApiSecurityScheme
-
Sets the security scheme parameters (if any).
- setSecuritySchemeReferenceName(String) - Method in class com.softwareag.centrasite.api.csom.ApiSecurityScheme
-
Sets the security scheme reference name which refers to the specification file (if any).
- setSecuritySchemes(Collection<ApiSecurityScheme>) - Method in interface com.softwareag.centrasite.api.csom.AbstractXMLService
-
Sets the security schemes applicable for this API.
- setSelectedAliases(List<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Sets the aliases for the service.
- setSelectedAliases(List<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Sets the aliases for the service.
- setSelectedAliases(List<CentraSiteRegistryObject>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.PublishAction
-
Sets the aliases for the service.
- setSelectedAliasListForUnpublish(Map<CentraSiteRegistryObject, List<Gateway>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- setSelectedAliasType(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the type of the Runtime alias.
- setSelectedApiPortals(Collection<APIPortal>) - Method in interface com.softwareag.centrasite.api.csom.action.portal.CentraSiteRegisterAction
-
Sets the
Collection
of
APIPortal
objects to which the API(s) must be register in to centrasite.
- setSelectedApiPortals(Collection<APIPortal>) - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Sets the
Collection
of
APIPortal
objects to which the API(s) must be published.
- setSelectedApiPortals(Collection<APIPortal>) - Method in interface com.softwareag.centrasite.api.csom.action.portal.UnpublishFromPortalAction
-
Sets the
Collection
of
APIPortal
objects from which the API(s) must be un-published.
- setSelectedApiPortals(Collection<APIPortal>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- setSelectedArchiveObjectKeys(Collection<String>) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Set the keys of the objects selected for import from the preview
- setSelectedCommunities(Map<String, Collection<String[]>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
Set map of all selected communities.
- setSelectedConsumerApplications(Collection<CentraSiteObject>) - Method in interface com.softwareag.centrasite.api.csom.action.ConsumeAction
-
- setSelectedEndpointSemantics(Collection<Category>) - Method in interface com.softwareag.centrasite.api.csom.action.portal.PublishToPortalAction
-
Sets the
Collection
of endpoint
Category
objects.
- setSelectedGatewayListForUnpublish(List<Gateway>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
- 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.
- setSelectedImportFileType(Category) - Method in interface com.softwareag.centrasite.api.activity.CreateAssetActivity
-
Sets the type of file to import by specifying the category id.
- setSelectedImportFileType(Category) - Method in interface com.softwareag.centrasite.api.csom.action.AttachDocumentAction
-
Sets the type of file to import by specifying the category id.
- setSelectedObjectKeys(Collection<String>) - Method in interface com.softwareag.centrasite.api.activity.ImportArchiveActivity
-
Set the keys to filter the archive import
- 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.
- setSelectedPortalEndpointSemantics(Map<APIPortal, Collection<Category>>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergePublishAction
-
- setSelectedPortalListforUnpublish(Collection<APIPortal>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Sets the
Collection
of
APIPortal
objects from which the API(s) must be un-published.
- setSelectedReport(CentraSiteObject) - Method in interface com.softwareag.centrasite.api.csom.action.ViewReportAction
-
Sets the selected report.
- setSelectedResources(List<String>) - Method in interface com.softwareag.centrasite.api.csom.action.VirtualizeAction
-
Sets the Resources to be virtualized.
- setSelectedRoles(Collection<Role>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleAction
-
Set the selected roles to be assigned to a group/user.
- setSelectedSecureAuthScheme(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimeAliasAction
-
Sets the Secure Alias authentication scheme.
- 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.
- setSelectedTypes(Collection<CentraSiteRegistryObjectType>) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the applicable type of the runtime policy
in case of empty or null specified throw an exception
- setSelectedUseCase(String) - Method in interface com.softwareag.centrasite.api.csom.action.AssetNavigatorAction
-
- setSelectedUsers(Collection<User>) - Method in interface com.softwareag.centrasite.api.csom.action.AssignUsersToGroupAction
-
Set the selected users to be assigned to a group.
- setSelectionList(HashMap<String, String>) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
Set a list of locale-specific labels with values for a selection list.
- setService(AbstractXMLService) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Sets the REST/XML service to the resource.
- setSize(Integer) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- 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.
- setStatus(APIPackageResponse.ExecutionStatus) - Method in class com.softwareag.centrasite.api.privilege.apiportal.APIPackageResponse
-
Sets the execution status
- setStatusCode(int) - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayCreateUpdateResponse
-
Set the Status of the operation.
- setStatusCode(int) - Method in class com.softwareag.centrasite.api.csom.action.runtime.GatewayGetResponse
-
Set the Status of the get operation
- setStatusCode(Category) - Method in interface com.softwareag.centrasite.api.csom.RESTPayload
-
Sets the status code object for the response payload object.
- setStatusCodes(Collection<RESTStatusCode>) - Method in interface com.softwareag.centrasite.api.csom.RESTMethod
-
- setSteps(int) - Method in class com.softwareag.centrasite.api.csom.action.portal.PublishToPortalCallback
-
- 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.
- setSubmittingOrganization(Organization) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set default submitting organization.
- setSubmittingOrganization(String) - Method in interface com.softwareag.centrasite.api.csom.ScheduledReport
-
Set default submitting organization.
- setSupportedMethods(Collection<Object>) - Method in interface com.softwareag.centrasite.api.csom.Resource
-
Sets the REST methods supported by the resource.
- setSystemDefined(boolean) - Method in interface com.softwareag.centrasite.api.csom.Role
-
Set whether the role is a system defined role or not.
- setTargetName(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteCommunicationDetails
-
- setTaxonomyBrowsable(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.AddTaxonomyAction
-
Mark a taxonomy as browsable.
- setTaxonomyDescription(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddTaxonomyAction
-
Set the description of the taxonomy.
- setTaxonomyName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddTaxonomyAction
-
Set the name of the taxonomy.
- 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.
- setTokenType(AccessTokenPolicyRequest.AccessTokenType) - Method in class com.softwareag.centrasite.api.privilege.service.AccessTokenPolicyRequest
-
- setTruncationLimit(Integer) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setType(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setType(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the type of the Gateway.
- setType(String) - Method in class com.softwareag.centrasite.api.csom.PostalAddress
-
Set the PostalAddress type.
- setType(String) - Method in class com.softwareag.centrasite.api.csom.ReportParameter
-
- setType(CSOSearch.SearchType) - Method in interface com.softwareag.centrasite.api.csom.search.CSOSearch
-
This is optional, in case of user not specified any SearchType then system treat the
search as Normal Search.
- setType(String) - Method in class com.softwareag.centrasite.api.privilege.service.Response
-
Sets the value of the type property.
- setTypeName(String) - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- setUddiKey(String) - Method in class com.softwareag.centrasite.api.activity.ArchiveObject
-
- 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.
- setUrl(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setUseCase(String) - Method in class com.softwareag.centrasite.api.assetnavigator.AssetNavigatorJSON
-
- setUser(String) - Method in class com.softwareag.centrasite.api.csom.action.GatewayConfiguration
-
Set the Gateway User.i.e Username of the Gateway instance
- 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.Gateway
-
- 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 class com.softwareag.centrasite.api.csom.action.APIPortalConfiguration
-
Sets the user id of the API-Portal which will be used for authenticating against the API-Portal.
- setUserId(String) - Method in interface com.softwareag.centrasite.api.csom.action.AssignRoleToUserAction
-
Set the user id to whom the roles should be assigned.
- setUserName(String) - Method in interface com.softwareag.centrasite.api.csom.action.AddAPIPortalAction
-
Sets the user id to
APIPortal
which will be used for authenticating against the API-Portal.
- setUserName(String) - Method in interface com.softwareag.centrasite.api.csom.APIPortal
-
Sets the user id to
APIPortal
which will be used for authenticating against the API-Portal.
- setUsername(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteImporterReference
-
Sets the username to access the reference file if it is a URL.
- 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.
- setUserVersion(String) - Method in class com.softwareag.centrasite.api.importer.CentraSiteAssetOptions
-
- 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.ReportParameter
-
- 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.
- setVersion(String) - Method in class com.softwareag.centrasite.api.csom.action.CentraSiteAccessDetails
-
- setVersion(String) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.ManageRuntimePolicyAction
-
set the policy version
- 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.MergePublishAction
-
Controls the visibility of the API being published.
- setVisibleToEveryOne(boolean) - Method in interface com.softwareag.centrasite.api.csom.action.runtime.MergeUnpublishAction
-
Controls the visibility of the API being published.
- 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_NAME_EXPORTER_CATEGORY - Static variable in interface com.softwareag.centrasite.api.common.constants.CSOMConstants
-
- SLOT_NAME_IMPORTER_CATEGORY - 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.csom.action.portal.PublishToPortalCallback
-
- stepMsg(String) - Method in class com.softwareag.centrasite.api.csom.action.portal.PublishToPortalCallback
-
- 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.
- syncConsumers(String) - Method in interface com.softwareag.centrasite.api.csom.runtime.DeploymentRESTClient
-
Sync Consumers present in CentraSite with the specified gateway
This method invokes a REST service which does the consumers synchronization
- 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
-