OsidProfile

All Superinterfaces:

Sourceable

All Known Subinterfaces:

AcknowledgementBatchManager, AcknowledgementBatchProfile, AcknowledgementBatchProxyManager, AcknowledgementManager, AcknowledgementProfile, AcknowledgementProxyManager, AssessmentAuthoringManager, AssessmentAuthoringProfile, AssessmentAuthoringProxyManager, AssessmentBatchManager, AssessmentBatchProfile, AssessmentBatchProxyManager, AssessmentManager, AssessmentProfile, AssessmentProxyManager, AuthenticationBatchManager, AuthenticationBatchProfile, AuthenticationBatchProxyManager, AuthenticationKeysBatchManager, AuthenticationKeysBatchProfile, AuthenticationKeysBatchProxyManager, AuthenticationKeysManager, AuthenticationKeysProfile, AuthenticationKeysProxyManager, AuthenticationManager, AuthenticationProcessManager, AuthenticationProcessProfile, AuthenticationProcessProxyManager, AuthenticationProfile, AuthenticationProxyManager, AuthorizationBatchManager, AuthorizationBatchProfile, AuthorizationBatchProxyManager, AuthorizationManager, AuthorizationProfile, AuthorizationProxyManager, AuthorizationRulesManager, AuthorizationRulesProfile, AuthorizationRulesProxyManager, BiddingBatchManager, BiddingBatchProfile, BiddingBatchProxyManager, BiddingManager, BiddingProfile, BiddingProxyManager, BiddingRulesManager, BiddingRulesProfile, BiddingRulesProxyManager, BillingBatchManager, BillingBatchProfile, BillingBatchProxyManager, BillingManager, BillingPaymentBatchManager, BillingPaymentBatchProfile, BillingPaymentBatchProxyManager, BillingPaymentManager, BillingPaymentProfile, BillingPaymentProxyManager, BillingProfile, BillingProxyManager, BloggingBatchManager, BloggingBatchProfile, BloggingBatchProxyManager, BloggingManager, BloggingProfile, BloggingProxyManager, CalendaringBatchManager, CalendaringBatchProfile, CalendaringBatchProxyManager, CalendaringCycleBatchManager, CalendaringCycleBatchProfile, CalendaringCycleBatchProxyManager, CalendaringCycleManager, CalendaringCycleProfile, CalendaringCycleProxyManager, CalendaringManager, CalendaringProfile, CalendaringProxyManager, CalendaringRulesManager, CalendaringRulesProfile, CalendaringRulesProxyManager, CatalogingManager, CatalogingProfile, CatalogingProxyManager, CatalogingRulesManager, CatalogingRulesProfile, CatalogingRulesProxyManager, ChecklistBatchManager, ChecklistBatchProfile, ChecklistBatchProxyManager, ChecklistManager, ChecklistMasonManager, ChecklistMasonProfile, ChecklistMasonProxyManager, ChecklistProfile, ChecklistProxyManager, CommentingBatchManager, CommentingBatchProfile, CommentingBatchProxyManager, CommentingManager, CommentingProfile, CommentingProxyManager, CommunicationManager, CommunicationProfile, CommunicationProxyManager, ConfigurationBatchManager, ConfigurationBatchProfile, ConfigurationBatchProxyManager, ConfigurationManager, ConfigurationProfile, ConfigurationProxyManager, ConfigurationRulesManager, ConfigurationRulesProfile, ConfigurationRulesProxyManager, ContactBatchManager, ContactBatchProfile, ContactBatchProxyManager, ContactManager, ContactProfile, ContactProxyManager, ContactRulesManager, ContactRulesProfile, ContactRulesProxyManager, ControlBatchManager, ControlBatchProfile, ControlBatchProxyManager, ControlManager, ControlProfile, ControlProxyManager, ControlRulesManager, ControlRulesProfile, ControlRulesProxyManager, CourseBatchManager, CourseBatchProfile, CourseBatchProxyManager, CourseChronicleBatchManager, CourseChronicleBatchProfile, CourseChronicleBatchProxyManager, CourseChronicleManager, CourseChronicleProfile, CourseChronicleProxyManager, CourseManager, CoursePlanManager, CoursePlanProfile, CoursePlanProxyManager, CourseProfile, CourseProgramBatchManager, CourseProgramBatchProfile, CourseProgramBatchProxyManager, CourseProgramManager, CourseProgramProfile, CourseProgramProxyManager, CourseProxyManager, CourseRegistrationBatchManager, CourseRegistrationBatchProfile, CourseRegistrationBatchProxyManager, CourseRegistrationManager, CourseRegistrationProfile, CourseRegistrationProxyManager, CourseRequisiteManager, CourseRequisiteProfile, CourseRequisiteProxyManager, CourseSyllabusBatchManager, CourseSyllabusBatchProfile, CourseSyllabusBatchProxyManager, CourseSyllabusManager, CourseSyllabusProfile, CourseSyllabusProxyManager, DictionaryBatchManager, DictionaryBatchProfile, DictionaryBatchProxyManager, DictionaryManager, DictionaryProfile, DictionaryProxyManager, FilingAllocationManager, FilingAllocationProfile, FilingAllocationProxyManager, FilingManager, FilingProfile, FilingProxyManager, FinancialsBatchManager, FinancialsBatchProfile, FinancialsBatchProxyManager, FinancialsBudgetingBatchManager, FinancialsBudgetingBatchProfile, FinancialsBudgetingBatchProxyManager, FinancialsBudgetingManager, FinancialsBudgetingProfile, FinancialsBudgetingProxyManager, FinancialsManager, FinancialsPostingBatchManager, FinancialsPostingBatchProfile, FinancialsPostingBatchProxyManager, FinancialsPostingManager, FinancialsPostingProfile, FinancialsPostingProxyManager, FinancialsProfile, FinancialsProxyManager, ForumBatchManager, ForumBatchProfile, ForumBatchProxyManager, ForumManager, ForumProfile, ForumProxyManager, GradingBatchManager, GradingBatchProfile, GradingBatchProxyManager, GradingCalculationManager, GradingCalculationProfile, GradingCalculationProxyManager, GradingManager, GradingProfile, GradingProxyManager, GradingTransformManager, GradingTransformProfile, GradingTransformProxyManager, HierarchyManager, HierarchyProfile, HierarchyProxyManager, HoldBatchManager, HoldBatchProfile, HoldBatchProxyManager, HoldManager, HoldProfile, HoldProxyManager, HoldRulesManager, HoldRulesProfile, HoldRulesProxyManager, IdBatchManager, IdBatchProfile, IdBatchProxyManager, IdManager, IdProfile, IdProxyManager, InquiryBatchManager, InquiryBatchProfile, InquiryBatchProxyManager, InquiryManager, InquiryProfile, InquiryProxyManager, InquiryRulesManager, InquiryRulesProfile, InquiryRulesProxyManager, InstallationBatchManager, InstallationBatchProfile, InstallationBatchProxyManager, InstallationManager, InstallationProfile, InstallationProxyManager, InventoryBatchManager, InventoryBatchProfile, InventoryBatchProxyManager, InventoryManager, InventoryProfile, InventoryProxyManager, InventoryShipmentBatchManager, InventoryShipmentBatchProfile, InventoryShipmentBatchProxyManager, InventoryShipmentManager, InventoryShipmentProfile, InventoryShipmentProxyManager, JournalingBatchManager, JournalingBatchProfile, JournalingBatchProxyManager, JournalingManager, JournalingProfile, JournalingProxyManager, LearningBatchManager, LearningBatchProfile, LearningBatchProxyManager, LearningManager, LearningProfile, LearningProxyManager, LocaleManager, LocaleProfile, LocaleProxyManager, LoggingBatchManager, LoggingBatchProfile, LoggingBatchProxyManager, LoggingManager, LoggingProfile, LoggingProxyManager, MappingBatchManager, MappingBatchProfile, MappingBatchProxyManager, MappingManager, MappingPathBatchManager, MappingPathBatchProfile, MappingPathBatchProxyManager, MappingPathManager, MappingPathProfile, MappingPathProxyManager, MappingPathRulesManager, MappingPathRulesProfile, MappingPathRulesProxyManager, MappingProfile, MappingProxyManager, MappingRouteManager, MappingRouteProfile, MappingRouteProxyManager, MessagingBatchManager, MessagingBatchProfile, MessagingBatchProxyManager, MessagingManager, MessagingProfile, MessagingProxyManager, MeteringBatchManager, MeteringBatchProfile, MeteringBatchProxyManager, MeteringManager, MeteringProfile, MeteringProxyManager, OfferingBatchManager, OfferingBatchProfile, OfferingBatchProxyManager, OfferingManager, OfferingProfile, OfferingProxyManager, OfferingRulesManager, OfferingRulesProfile, OfferingRulesProxyManager, OntologyBatchManager, OntologyBatchProfile, OntologyBatchProxyManager, OntologyManager, OntologyProfile, OntologyProxyManager, OntologyRulesManager, OntologyRulesProfile, OntologyRulesProxyManager, OrchestrationManager, OrchestrationProfile, OrderingBatchManager, OrderingBatchProfile, OrderingBatchProxyManager, OrderingManager, OrderingProfile, OrderingProxyManager, OrderingRulesManager, OrderingRulesProfile, OrderingRulesProxyManager, OsidManager, OsidProxyManager, OsidRuntimeManager, OsidRuntimeProfile, PersonnelBatchManager, PersonnelBatchProfile, PersonnelBatchProxyManager, PersonnelManager, PersonnelProfile, PersonnelProxyManager, ProcessManager, ProcessProfile, ProcessProxyManager, ProfileBatchManager, ProfileBatchProfile, ProfileBatchProxyManager, ProfileManager, ProfileProfile, ProfileProxyManager, ProfileRulesManager, ProfileRulesProfile, ProfileRulesProxyManager, ProvisioningBatchManager, ProvisioningBatchProfile, ProvisioningBatchProxyManager, ProvisioningManager, ProvisioningProfile, ProvisioningProxyManager, ProvisioningRulesManager, ProvisioningRulesProfile, ProvisioningRulesProxyManager, ProxyManager, ProxyProfile, ProxyProxyManager, RecipeBatchManager, RecipeBatchProfile, RecipeBatchProxyManager, RecipeManager, RecipeProfile, RecipeProxyManager, RecognitionBatchManager, RecognitionBatchProfile, RecognitionBatchProxyManager, RecognitionManager, RecognitionProfile, RecognitionProxyManager, RelationshipBatchManager, RelationshipBatchProfile, RelationshipBatchProxyManager, RelationshipManager, RelationshipProfile, RelationshipProxyManager, RelationshipRulesManager, RelationshipRulesProfile, RelationshipRulesProxyManager, RepositoryBatchManager, RepositoryBatchProfile, RepositoryBatchProxyManager, RepositoryManager, RepositoryProfile, RepositoryProxyManager, RepositoryRulesManager, RepositoryRulesProfile, RepositoryRulesProxyManager, ResourceBatchManager, ResourceBatchProfile, ResourceBatchProxyManager, ResourceDemographicManager, ResourceDemographicProfile, ResourceDemographicProxyManager, ResourceManager, ResourceProfile, ResourceProxyManager, ResourcingBatchManager, ResourcingBatchProfile, ResourcingBatchProxyManager, ResourcingManager, ResourcingProfile, ResourcingProxyManager, ResourcingRulesManager, ResourcingRulesProfile, ResourcingRulesProxyManager, RoomBatchManager, RoomBatchProfile, RoomBatchProxyManager, RoomConstructionBatchManager, RoomConstructionBatchProfile, RoomConstructionBatchProxyManager, RoomConstructionManager, RoomConstructionProfile, RoomConstructionProxyManager, RoomManager, RoomProfile, RoomProxyManager, RoomSquattingBatchManager, RoomSquattingBatchProfile, RoomSquattingBatchProxyManager, RoomSquattingManager, RoomSquattingProfile, RoomSquattingProxyManager, RulesCheckManager, RulesCheckProfile, RulesCheckProxyManager, RulesManager, RulesProfile, RulesProxyManager, SearchManager, SearchProfile, SearchProxyManager, SequencingManager, SequencingProfile, SequencingProxyManager, SubscriptionBatchManager, SubscriptionBatchProfile, SubscriptionBatchProxyManager, SubscriptionManager, SubscriptionProfile, SubscriptionProxyManager, SubscriptionRulesManager, SubscriptionRulesProfile, SubscriptionRulesProxyManager, TopologyBatchManager, TopologyBatchProfile, TopologyBatchProxyManager, TopologyManager, TopologyPathManager, TopologyPathProfile, TopologyPathProxyManager, TopologyProfile, TopologyProxyManager, TopologyRulesManager, TopologyRulesProfile, TopologyRulesProxyManager, TrackingBatchManager, TrackingBatchProfile, TrackingBatchProxyManager, TrackingManager, TrackingProfile, TrackingProxyManager, TrackingRulesManager, TrackingRulesProfile, TrackingRulesProxyManager, TransactionManager, TransactionProfile, TransactionProxyManager, TransportManager, TransportProfile, TransportProxyManager, TypeManager, TypeProfile, TypeProxyManager, VotingBatchManager, VotingBatchProfile, VotingBatchProxyManager, VotingManager, VotingProfile, VotingProxyManager, VotingRulesManager, VotingRulesProfile, VotingRulesProxyManager, WorkflowBatchManager, WorkflowBatchProfile, WorkflowBatchProxyManager, WorkflowManager, WorkflowProfile, WorkflowProxyManager, WorkflowRulesManager, WorkflowRulesProfile, WorkflowRulesProxyManager
```
public interface OsidProfile
extends Sourceable
```
The OsidProfile defines the interoperability areas of an OSID. An OsidProfile is implemented by an OsidManager. The top level OsidProfile tests for version compatibility. Each OSID extends this interface to include its own interoperability definitions within its managers.

Method Summary

Methods
Modifier and Type	Method and Description
`Branch`	`getBranch()` Gets this service branch.
`Id`	`getBranchId()` Gets the `Branch Id` representing this service branch.
`DisplayText`	`getDescription()` Gets a description of this service implementation.
`DisplayText`	`getDisplayName()` Gets a display name for this service implementation.
`Id`	`getId()` Gets an identifier for this service implementation.
`LocaleList`	`getLocales()` Gets the locales supported in this service.
`TypeList`	`getProxyRecordTypes()` Gets the proxy record `Types` supported in this service.
`DateTime`	`getReleaseDate()` Gets the date this service implementation was released.
`Version`	`getVersion()` Gets the version of this service implementation.
`boolean`	`supportsJournalBranching()` Test for support of a journal branching service.
`boolean`	`supportsJournalRollback()` Test for support of a journaling rollback service.
`boolean`	`supportsOSIDVersion(Version version)` Test for support of an OSID specification version.
`boolean`	`supportsProxyRecordType(Type proxyRecordType)` Test for support of a proxy type.

Methods inherited from interface org.osid.Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderId

- Method Detail
  - getId
```
Id getId()
```
    Gets an identifier for this service implementation. The identifier is unique among services but multiple instantiations of the same service use the same Id. This identifier is the same identifier used in managing OSID installations.
    
    Returns:
    the Id
    
    Compliance:
    mandatory - This method must be implemented.
  - getDisplayName
```
DisplayText getDisplayName()
```
    Gets a display name for this service implementation.
    
    Returns:
    a display name
    
    Compliance:
    mandatory - This method must be implemented.
  - getDescription
```
DisplayText getDescription()
```
    Gets a description of this service implementation.
    
    Returns:
    a description
    
    Compliance:
    mandatory - This method must be implemented.
  - getVersion
```
Version getVersion()
```
    Gets the version of this service implementation.
    
    Returns:
    the service implementation version
    
    Compliance:
    mandatory - This method must be implemented.
  - getReleaseDate
```
DateTime getReleaseDate()
```
    Gets the date this service implementation was released.
    
    Returns:
    the release date
    
    Compliance:
    mandatory - This method must be implemented.
  - supportsOSIDVersion
```
boolean supportsOSIDVersion(Version version)
```
    Test for support of an OSID specification version.
    
    Parameters:
    version - the specification version to test
    
    Returns:
    true if this manager supports the given OSID version, false otherwise
    
    Compliance:
    mandatory - This method must be implemented.
    
    Notes:
    An - implementation may support multiple versions of an OSID.
  - getLocales
```
LocaleList getLocales()
```
    Gets the locales supported in this service.
    
    Returns:
    list of locales supported
    
    Compliance:
    mandatory - This method must be implemented.
  - supportsJournalRollback
```
boolean supportsJournalRollback()
```
    Test for support of a journaling rollback service.
    
    Returns:
    true if this manager supports the journal rollback, false otherwise
    
    Compliance:
    mandatory - This method must be implemented.
  - supportsJournalBranching
```
boolean supportsJournalBranching()
```
    Test for support of a journal branching service.
    
    Returns:
    true if this manager supports the journal branching, false otherwise
    
    Compliance:
    mandatory - This method must be implemented.
  - getBranchId
```
Id getBranchId()
```
    Gets the Branch Id representing this service branch.
    
    Returns:
    the branch Id
    
    Throws:
    
    UnimplementedException - supportsJournalBranching() is false
    
    Compliance:
    mandatory - This method must be implemented.
  - getBranch
```
Branch getBranch()
                 throws OperationFailedException
```
    Gets this service branch.
    
    Returns:
    the service branch
    
    Throws:
    
    OperationFailedException - unable to complete request
    
    UnimplementedException - supportsJournalBranching() is false
    
    Compliance:
    mandatory - This method must be implemented.
  - getProxyRecordTypes
```
TypeList getProxyRecordTypes()
```
    Gets the proxy record Types supported in this service. If no proxy manager is available, an empty list is returned.
    
    Returns:
    list of proxy record types supported
    
    Compliance:
    mandatory - This method must be implemented.
  - supportsProxyRecordType
```
boolean supportsProxyRecordType(Type proxyRecordType)
```
    Test for support of a proxy type.
    
    Parameters:
    proxyRecordType - a proxy record type
    
    Returns:
    true if this service supports the given proxy record type, false otherwise
    
    Throws:
    
    NullArgumentException - proxyRecordType is null
    
    Compliance:
    mandatory - This method must be implemented.

Interface OsidProfile

Method Summary

Methods inherited from interface org.osid.Sourceable

Method Detail

getId

getDisplayName

getDescription

getVersion

getReleaseDate

supportsOSIDVersion

getLocales

supportsJournalRollback

supportsJournalBranching

getBranchId

getBranch

getProxyRecordTypes

supportsProxyRecordType