Class AbstractOsidManager
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidManager
- All Implemented Interfaces:
Closeable, AutoCloseable, OsidManager, OsidProxyManager, OsidManager, OsidProfile, OsidProxyManager, Sourceable
- Direct Known Subclasses:
AbstractAcknowledgementBatchManager, AbstractAcknowledgementManager, AbstractAssessmentAuthoringManager, AbstractAssessmentBatchManager, AbstractAssessmentManager, AbstractAuthenticationBatchManager, AbstractAuthenticationKeysBatchManager, AbstractAuthenticationKeysManager, AbstractAuthenticationManager, AbstractAuthenticationProcessManager, AbstractAuthorizationBatchManager, AbstractAuthorizationManager, AbstractAuthorizationRulesManager, AbstractBiddingBatchManager, AbstractBiddingManager, AbstractBiddingRulesManager, AbstractBillingBatchManager, AbstractBillingManager, AbstractBillingPaymentBatchManager, AbstractBillingPaymentManager, AbstractBloggingBatchManager, AbstractBloggingManager, AbstractCalendaringBatchManager, AbstractCalendaringCycleBatchManager, AbstractCalendaringCycleManager, AbstractCalendaringManager, AbstractCalendaringRulesManager, AbstractCatalogingManager, AbstractCatalogingRulesManager, AbstractChecklistBatchManager, AbstractChecklistManager, AbstractChecklistMasonManager, AbstractCommentingBatchManager, AbstractCommentingManager, AbstractCommunicationManager, AbstractConfigurationBatchManager, AbstractConfigurationManager, AbstractConfigurationRulesManager, AbstractContactBatchManager, AbstractContactManager, AbstractContactRulesManager, AbstractControlBatchManager, AbstractControlManager, AbstractControlRulesManager, AbstractCourseBatchManager, AbstractCourseChronicleBatchManager, AbstractCourseChronicleManager, AbstractCourseManager, AbstractCoursePlanManager, AbstractCourseProgramBatchManager, AbstractCourseProgramManager, AbstractCourseRegistrationBatchManager, AbstractCourseRegistrationManager, AbstractCourseRequisiteManager, AbstractCourseSyllabusBatchManager, AbstractCourseSyllabusManager, AbstractDictionaryBatchManager, AbstractDictionaryManager, AbstractDynamicOsidManager, AbstractFilingAllocationManager, AbstractFilingManager, AbstractFinancialsBatchManager, AbstractFinancialsBudgetingBatchManager, AbstractFinancialsBudgetingManager, AbstractFinancialsManager, AbstractFinancialsPostingBatchManager, AbstractFinancialsPostingManager, AbstractForumBatchManager, AbstractForumManager, AbstractGradingBatchManager, AbstractGradingCalculationManager, AbstractGradingManager, AbstractGradingTransformManager, AbstractHierarchyManager, AbstractHoldBatchManager, AbstractHoldManager, AbstractHoldRulesManager, AbstractIdBatchManager, AbstractIdManager, AbstractInquiryBatchManager, AbstractInquiryManager, AbstractInquiryRulesManager, AbstractInstallationBatchManager, AbstractInstallationManager, AbstractInventoryBatchManager, AbstractInventoryManager, AbstractInventoryShipmentBatchManager, AbstractInventoryShipmentManager, AbstractJournalingBatchManager, AbstractJournalingManager, AbstractLearningBatchManager, AbstractLearningManager, AbstractLexiconBatchManager, AbstractLexiconManager, AbstractLocaleManager, AbstractLoggingBatchManager, AbstractLoggingManager, AbstractMappingBatchManager, AbstractMappingManager, AbstractMappingPathBatchManager, AbstractMappingPathManager, AbstractMappingPathRulesManager, AbstractMappingRouteManager, AbstractMessagingBatchManager, AbstractMessagingManager, AbstractMeteringBatchManager, AbstractMeteringManager, AbstractOfferingBatchManager, AbstractOfferingManager, AbstractOfferingRulesManager, AbstractOntologyBatchManager, AbstractOntologyManager, AbstractOntologyRulesManager, AbstractOrchestrationManager, AbstractOrderingBatchManager, AbstractOrderingManager, AbstractOrderingRulesManager, AbstractOsidRuntimeManager, AbstractPersonnelBatchManager, AbstractPersonnelManager, AbstractProcessManager, AbstractProfileBatchManager, AbstractProfileManager, AbstractProfileRulesManager, AbstractProvisioningBatchManager, AbstractProvisioningManager, AbstractProvisioningRulesManager, AbstractProxyManager, AbstractRecipeBatchManager, AbstractRecipeManager, AbstractRecognitionBatchManager, AbstractRecognitionManager, AbstractRelationshipBatchManager, AbstractRelationshipManager, AbstractRelationshipRulesManager, AbstractRepositoryBatchManager, AbstractRepositoryManager, AbstractRepositoryRulesManager, AbstractResourceBatchManager, AbstractResourceDemographicManager, AbstractResourceManager, AbstractResourcingBatchManager, AbstractResourcingManager, AbstractResourcingRulesManager, AbstractRoomBatchManager, AbstractRoomConstructionBatchManager, AbstractRoomConstructionManager, AbstractRoomManager, AbstractRoomSquattingBatchManager, AbstractRoomSquattingManager, AbstractRulesCheckManager, AbstractRulesManager, AbstractSearchManager, AbstractSequencingManager, AbstractSubscriptionBatchManager, AbstractSubscriptionManager, AbstractSubscriptionRulesManager, AbstractTopologyBatchManager, AbstractTopologyManager, AbstractTopologyPathManager, AbstractTopologyRulesManager, AbstractTrackingBatchManager, AbstractTrackingManager, AbstractTrackingRulesManager, AbstractTransactionManager, AbstractTransportManager, AbstractTypeManager, AbstractVotingBatchManager, AbstractVotingManager, AbstractVotingRulesManager, AbstractWorkflowBatchManager, AbstractWorkflowEventManager, AbstractWorkflowManager, AbstractWorkflowRulesManager
This is a manager abstract class for handling common manager and
profile methods. Objects extending this class can use various
setters to supply the information. This abstract class implements
both the
OsidManager and OsidProxyManager
interfaces.
Objects extending this class should use the following to set their
information using the ServiceProvider.
The service messages, locale and proxy types are optional. This
manager does not support journaling but the journaling methods can
be overridden.-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractOsidManager(ServiceProvider provider) Constructs a newAbstractOsidManager. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds support for a locale.protected voidaddOSIDVersion(Version version) Adds support for an OSID version.voidchangeBranch(Id branchId) Changes the service branch.voidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidclose()Closes this manager.protected BooleangetBooleanConfigurationValue(Id parameterId, Boolean defaultValue) Gets the boolean value for the given Parameter.Gets this service branch.Gets theBranch Idrepresenting this service branch.Gets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding asset Ids, such as an image or logo, expressed using theAssetinterface.protected byte[]getBytesConfigurationValue(Id parameterId, byte[] defaultValue) Gets the bytes value for the given Parameter.protected LonggetCardinalConfigurationValue(Id parameterId, Long defaultValue) Gets the cardinal value for the given Parameter.protected ValuegetConfigurationValue(Id parameterId) Gets aValuefor the given parameterId.protected ValueListgetConfigurationValues(Id parameterId) Gets all theValuesfor the given parameterId.protected CoordinategetCoordinateConfigurationValue(Id parameterId, Coordinate defaultValue) Gets the coordinate value for the given Parameter.protected CurrencygetCurrencyConfigurationValue(Id parameterId, Currency defaultValue) Gets the currency value for the given Parameter.protected DateTimegetDateTimeConfigurationValue(Id parameterId, DateTime defaultValue) Gets the datetime value for the given Parameter.protected BigDecimalgetDecimalConfigurationValue(Id parameterId, BigDecimal defaultValue) Gets the decimal value for the given Parameter.Gets a description of this service implementation.Gets a display name for this service implementation.protected DisplayTextgetDisplayTextConfigurationValue(Id parameterId, DisplayText defaultValue) Gets the DisplayText value for the given Parameter.protected DurationgetDurationConfigurationValue(Id parameterId, Duration defaultValue) Gets the duration value for the given Parameter.protected HeadinggetHeadingConfigurationValue(Id parameterId, Heading defaultValue) Gets the heading value for the given Parameter.getId()Gets an identifier for this service implementation.protected IdgetIdConfigurationValue(Id parameterId, Id defaultValue) Gets the Id value for the given Parameter.protected LonggetIntegerConfigurationValue(Id parameterId, Long defaultValue) Gets the integer value for the given Parameter.Gets the terms of usage with respect to this service implementation.Gets the locales supported in this service.protected voidgetNoneConfigurationValue(Id parameterId) Gets the nothing for the given Parameter.protected ObjectgetObjectConfigurationValue(Id parameterId, Object defaultValue) Gets the object value for the given Parameter.protected OsidManagergetOsidManager(OSID osid, String implClassName) Instantiates an OsidManager.protected OsidProxyManagergetOsidProxyManager(OSID osid, String implClassName) Instantiates an OsidProxyManager.Gets the provider of this service, expressed using theResourceinterface.Gets theResource Idrepresenting the provider of this service.getProxy(ProxyCondition input) Gets a Proxy for use in this manager.Gets the ProxyCondition for requesting a Proxy.Gets the date this service implementation was released.protected OsidRuntimeManagerGets the runtime environment.protected SpeedgetSpeedConfigurationValue(Id parameterId, Speed defaultValue) Gets the speed value for the given Parameter.protected StringgetStringConfigurationValue(Id parameterId, String defaultValue) Gets the string value for the given Parameter.protected TimegetTimeConfigurationValue(Id parameterId, Time defaultValue) Gets the time value for the given Parameter.protected TypegetTypeConfigurationValue(Id parameterId, Type defaultValue) Gets the Type value for the given Parameter.Gets the version of this service implementation.protected VersiongetVersionConfigurationValue(Id parameterId, Version defaultValue) Gets the Version value for the given Parameter.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.protected voidsetRuntime(OsidRuntimeManager runtime) Sets the runtime environment.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID version.
-
Constructor Details
-
AbstractOsidManager
Constructs a newAbstractOsidManager.- Parameters:
provider- a service provider- Throws:
NullArgumentException-providerisnull
-
-
Method Details
-
initialize
@OSID public void initialize(OsidRuntimeManager runtime) throws ConfigurationErrorException, OperationFailedException Initializes this manager. A manager is initialized once at the time of creation.- Specified by:
initializein interfaceOsidManager- Specified by:
initializein interfaceOsidProxyManager- Parameters:
runtime- the runtime environment- Throws:
ConfigurationErrorException- an error with implementation configurationIllegalStateException- this manager has already been initialized by theOsidLoaderNullArgumentException-runtimeisnullOperationFailedException- unable to complete request
-
getRuntime
-
setRuntime
Sets the runtime environment.- Parameters:
runtime- the runtime to set- Throws:
NullArgumentException-runtimeis null
-
getId
Gets an identifier for this service implementation. The identifier is unique among services but multiple instantiations of the same service use the sameId. This identifier is the same identifier used in managing OSID installations.- Specified by:
getIdin interfaceOsidProfile- Returns:
- the
Id - Throws:
IllegalStateException- This manager has been closed.
-
getDisplayName
Gets a display name for this service implementation.- Specified by:
getDisplayNamein interfaceOsidProfile- Returns:
- a display name
- Throws:
IllegalStateException- This manager has been closed.
-
getDescription
Gets a description of this service implementation.- Specified by:
getDescriptionin interfaceOsidProfile- Returns:
- a description
- Throws:
IllegalStateException- This manager has been closed.
-
getVersion
Gets the version of this service implementation.- Specified by:
getVersionin interfaceOsidProfile- Returns:
- the version
- Throws:
IllegalStateException- This manager has been closed.
-
getReleaseDate
Gets the date this service implementation was released.- Specified by:
getReleaseDatein interfaceOsidProfile- Returns:
- the release date
- Throws:
IllegalStateException- This manager has been closed.
-
supportsOSIDVersion
Test for support of an OSID version.- Specified by:
supportsOSIDVersionin interfaceOsidProfile- Parameters:
version- the version string to test- Returns:
trueif this manager supports the given version,falseotherwise
-
addOSIDVersion
Adds support for an OSID version.- Parameters:
version- an OSID version- Throws:
NullArgumentException-versionisnull
-
getLocales
Gets the locales supported in this service.- Specified by:
getLocalesin interfaceOsidProfile- Returns:
- list of locales supported
-
addLocale
Adds support for a locale.- Parameters:
locale- the locale to add- Throws:
NullArgumentException-localeisnull
-
supportsJournalRollback
public boolean supportsJournalRollback()Test for support of a journaling rollback service.- Specified by:
supportsJournalRollbackin interfaceOsidProfile- Returns:
trueif this manager supports the journal rollback,falseotherwise
-
supportsJournalBranching
Test for support of a journal branching service.- Specified by:
supportsJournalBranchingin interfaceOsidProfile- Returns:
trueif this manager supports the journal branching,falseotherwise
-
getBranchId
Gets theBranch Idrepresenting this service branch.- Specified by:
getBranchIdin interfaceOsidProfile- Returns:
- the branch
Id - Throws:
UnimplementedException-supportsJournalBranching()isfalse
-
getBranch
Gets this service branch.- Specified by:
getBranchin interfaceOsidProfile- Returns:
- the service branch
- Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJournalBranching()isfalse
-
rollbackService
@OSID public JournalEntry rollbackService(Date rollbackTime) throws OperationFailedException, PermissionDeniedException Rolls back this service to a point in time.- Specified by:
rollbackServicein interfaceOsidManager- Parameters:
rollbackTime- the requested time- Returns:
- the journal entry corresponding to the actual state of this service
- Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalRollback()isfalse
-
rollbackService
@OSID public JournalEntry rollbackService(Date rollbackTime, Proxy proxy) throws OperationFailedException Rolls back this service to a point in time.- Specified by:
rollbackServicein interfaceOsidProxyManager- Parameters:
rollbackTime- the requested timeproxy- a proxy- Returns:
- the journal entry corresponding to the actual state of this service
- Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJournalRollback()isfalse
-
changeBranch
@OSID public void changeBranch(Id branchId) throws NotFoundException, OperationFailedException, PermissionDeniedException Changes the service branch.- Specified by:
changeBranchin interfaceOsidManager- Parameters:
branchId- the new service branch- Throws:
NotFoundException-branchIdnot foundNullArgumentException-branchIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalBranching()isfalse
-
changeBranch
@OSID public void changeBranch(Id branchId, Proxy proxy) throws NotFoundException, OperationFailedException, PermissionDeniedException Changes the service branch.- Specified by:
changeBranchin interfaceOsidProxyManager- Parameters:
branchId- the new service branchproxy- a proxy- Throws:
NotFoundException-branchIdnot foundNullArgumentException-branchIdorproxyisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnimplementedException-supportsJournalBranching()isfalse
-
getProxyCondition
Gets the ProxyCondition for requesting a Proxy.- Specified by:
getProxyConditionin interfaceOsidProxyManager- Returns:
- a ProxyCondition
- Throws:
OperationFailedException- unable to complete request
-
getProxy
Gets a Proxy for use in this manager. This method should be overidden if other ProxyConditions are supported.- Specified by:
getProxyin interfaceOsidProxyManager- Parameters:
input- a the ProxyCondition- Returns:
- a Proxy
- Throws:
NullArgumentException-inputisnullOperationFailedException- unable to complete requestUnsupportedException-inputdid not originate fromgetProxyCondition()
-
getLicense
Gets the terms of usage with respect to this service implementation.- Specified by:
getLicensein interfaceSourceable- Returns:
- the license
- Throws:
IllegalStateException- This manager has been closed.
-
getProviderId
Gets theResource Idrepresenting the provider of this service.- Specified by:
getProviderIdin interfaceSourceable- Returns:
- the provider
Id - Throws:
IllegalStateException- This manager has been closed.
-
getProvider
Gets the provider of this service, expressed using theResourceinterface.- Specified by:
getProviderin interfaceSourceable- Returns:
- the service provider resource
- Throws:
IllegalStateException- This manager has been closed.OperationFailedException- unable to complete request
-
getBrandingIds
Gets the branding asset Ids, such as an image or logo, expressed using theAssetinterface.- Specified by:
getBrandingIdsin interfaceSourceable- Returns:
- a list of asset Ids
-
getBranding
Gets a branding, such as an image or logo, expressed using theAssetinterface.- Specified by:
getBrandingin interfaceSourceable- Returns:
- a list of assets
- Throws:
IllegalStateException- This manager has been closed.OperationFailedException- unable to complete request
-
getOsidManager
protected OsidManager getOsidManager(OSID osid, String implClassName) throws ConfigurationErrorException, OperationFailedException Instantiates an OsidManager.- Parameters:
osid- the OSID to loadimplClassName- the name of the implementation- Returns:
- the OsidManager
- Throws:
ConfigurationErrorException- an error in configuring the implementationIllegalStateException- manager not initializedOperationFailedException- unable to complete requestNullArgumentException-implClassNameorversionisnullOperationFailedException- unable to completeUnsupportedException-implClassNamedoes not support the requested OSID
-
getOsidProxyManager
protected OsidProxyManager getOsidProxyManager(OSID osid, String implClassName) throws ConfigurationErrorException, OperationFailedException Instantiates an OsidProxyManager.- Parameters:
osid- the OSID to loadimplClassName- the name of the implementation- Returns:
- the OsidManager
- Throws:
ConfigurationErrorException- an error in configuring the implementationIllegalStateException- manager not initializedOperationFailedException- unable to complete requestNullArgumentException-implClassNameorversionisnullOperationFailedException- unable to completeUnsupportedException-implClassNamedoes not support the requested OSID
-
getConfigurationValue
protected Value getConfigurationValue(Id parameterId) throws ConfigurationErrorException, OperationFailedException Gets aValuefor the given parameterId. If more than one value exists for the given parameter, the most preferred value is returned. This method can be used as a convenience when only one value is expected.getApplicableValuesByParameters()should be used for getting all the active values.- Parameters:
parameterId- theIdof theParameterto retrieve- Returns:
- the value
- Throws:
ConfigurationErrorException- theparameterIdnot found or no value availableIllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getNoneConfigurationValue
Gets the nothing for the given Parameter. If the parameter is not found, nothing is returned.- Parameters:
parameterId- theIdof theParameterto retrieve- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getBooleanConfigurationValue
protected Boolean getBooleanConfigurationValue(Id parameterId, Boolean defaultValue) throws OperationFailedException Gets the boolean value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getBytesConfigurationValue
protected byte[] getBytesConfigurationValue(Id parameterId, byte[] defaultValue) throws OperationFailedException Gets the bytes value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getCardinalConfigurationValue
protected Long getCardinalConfigurationValue(Id parameterId, Long defaultValue) throws OperationFailedException Gets the cardinal value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getCoordinateConfigurationValue
protected Coordinate getCoordinateConfigurationValue(Id parameterId, Coordinate defaultValue) throws OperationFailedException Gets the coordinate value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getCurrencyConfigurationValue
protected Currency getCurrencyConfigurationValue(Id parameterId, Currency defaultValue) throws OperationFailedException Gets the currency value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getDateTimeConfigurationValue
protected DateTime getDateTimeConfigurationValue(Id parameterId, DateTime defaultValue) throws OperationFailedException Gets the datetime value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getDecimalConfigurationValue
protected BigDecimal getDecimalConfigurationValue(Id parameterId, BigDecimal defaultValue) throws OperationFailedException Gets the decimal value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getDisplayTextConfigurationValue
protected DisplayText getDisplayTextConfigurationValue(Id parameterId, DisplayText defaultValue) throws OperationFailedException Gets the DisplayText value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getDurationConfigurationValue
protected Duration getDurationConfigurationValue(Id parameterId, Duration defaultValue) throws OperationFailedException Gets the duration value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getHeadingConfigurationValue
protected Heading getHeadingConfigurationValue(Id parameterId, Heading defaultValue) throws OperationFailedException Gets the heading value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getIdConfigurationValue
protected Id getIdConfigurationValue(Id parameterId, Id defaultValue) throws OperationFailedException Gets the Id value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getIntegerConfigurationValue
protected Long getIntegerConfigurationValue(Id parameterId, Long defaultValue) throws OperationFailedException Gets the integer value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getObjectConfigurationValue
protected Object getObjectConfigurationValue(Id parameterId, Object defaultValue) throws OperationFailedException Gets the object value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getSpeedConfigurationValue
protected Speed getSpeedConfigurationValue(Id parameterId, Speed defaultValue) throws OperationFailedException Gets the speed value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getStringConfigurationValue
protected String getStringConfigurationValue(Id parameterId, String defaultValue) throws OperationFailedException Gets the string value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getTimeConfigurationValue
protected Time getTimeConfigurationValue(Id parameterId, Time defaultValue) throws OperationFailedException Gets the time value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getTypeConfigurationValue
protected Type getTypeConfigurationValue(Id parameterId, Type defaultValue) throws OperationFailedException Gets the Type value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getVersionConfigurationValue
protected Version getVersionConfigurationValue(Id parameterId, Version defaultValue) throws OperationFailedException Gets the Version value for the given Parameter. If the parameter is not found, the default value is returned. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrievedefaultValue- the default value- Returns:
- the configuration value or the default
- Throws:
IllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
getConfigurationValues
protected ValueList getConfigurationValues(Id parameterId) throws ConfigurationErrorException, OperationFailedException Gets all theValuesfor the given parameterId. The default value can benull.- Parameters:
parameterId- theIdof theParameterto retrieve- Returns:
- the value list
- Throws:
ConfigurationErrorException- theparameterIdnot foundIllegalStateException- manager not initializedNullArgumentException- theparameterIdisnullOperationFailedException- unable to complete request
-
close
Closes this manager.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceOsidManager- Specified by:
closein interfaceOsidProxyManager- Throws:
IllegalStateException- this manager has been closed
-