OSID - osid.authentication.AuthenticationProfile Service Interface Definition

Interface	osid.authentication.AuthenticationProfile
Implements	`osid.OsidProfile`
Description	The `AuthenticationProfile` describes the interoperability among authentication services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthenticationAcquisition
Description	Tests is authentication acquisition is supported. Authentication acquisition is responsible for acquiring client side authentication credentials.
Return	`boolean`		`true` if authentication acquisiiton is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthenticationValidation
Description	Tests if authentication validation is supported. Authentication validation verifies given authentication credentials and maps to an agent identity.
Return	`boolean`		`true` if authentication validation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentLookup
Description	Tests if an agent lookup service is supported. An agent lookup service defines methods to access agents.
Return	`boolean`		`true` if agent lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentQuery
Description	Tests if an agent query service is supported.
Return	`boolean`		`true` if agent query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentSearch
Description	Tests if an agent search service is supported.
Return	`boolean`		`true` if agent search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentAdmin
Description	Tests if an agent administrative service is supported.
Return	`boolean`		`true` if agent admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentNotification
Description	Tests if agent notification is supported. Messages may be sent when agents are created, modified, or deleted.
Return	`boolean`		`true` if agent notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentAgency
Description	Tests if retrieving mappings of agents and agencies is supported.
Return	`boolean`		`true` if agent agency mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentAgencyAssignment
Description	Tests if managing mappings of agents and agencies is supported.
Return	`boolean`		`true` if agent agency assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentSmartAgency
Description	Tests if agent smart agency is available.
Return	`boolean`		`true` if agent smart agency is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyLookup
Description	Tests if an agency lookup service is supported. An agency lookup service defines methods to access agencies.
Return	`boolean`		`true` if agency lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyQuery
Description	Tests if an agency query service is supported.
Return	`boolean`		`true` if agency query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencySearch
Description	Tests if an agency search service is supported.
Return	`boolean`		`true` if agency search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyAdmin
Description	Tests if an agency administrative service is supported.
Return	`boolean`		`true` if agency admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyNotification
Description	Tests if agency notification is supported. Messages may be sent when agencies are created, modified, or deleted.
Return	`boolean`		`true` if agency notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyHierarchy
Description	Tests if an agency hierarchy traversal is supported.
Return	`boolean`		`true` if an agency hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyHierarchyDesign
Description	Tests if an agency hierarchy design is supported.
Return	`boolean`		`true` if an agency hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthenticationKeys
Description	Tests if an authentication key service is available.
Return	`boolean`		`true` if an authentication key service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthenticationProcess
Description	Tests if an authentication process service is available.
Return	`boolean`		`true` if an authentication process service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentRecordTypes
Description	Gets the supported `Agent` record types.
Return	`osid.type.TypeList`		a list containing the supported `Agent` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentRecordType
Description	Tests if the given `Agent` record type is supported.
Parameters	`osid.type.Type`	`agentRecordType`	a `Type` indicating an `Agent` record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgentSearchRecordTypes
Description	Gets the supported `Agent` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Agent` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgentSearchRecordType
Description	Tests if the given `Agent` search record type is supported.
Parameters	`osid.type.Type`	`agentSearchRecordType`	a `Type` indicating an `Agent` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgencyRecordTypes
Description	Gets the supported `Agency` record types.
Return	`osid.type.TypeList`		a list containing the supported `Agency` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyRecordType
Description	Tests if the given `Agency` record type is supported.
Parameters	`osid.type.Type`	`agencyRecordType`	a `Type` indicating an `Agency` record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agencyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAgencySearchRecordTypes
Description	Gets the supported `Agency` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Agency` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencySearchRecordType
Description	Tests if the given `Agency` search record type is supported.
Parameters	`osid.type.Type`	`agencySearchRecordType`	a `Type` indicating an `Agency` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`agencySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.