OSID - osid.authorization.AuthorizationProfile Service Interface Definition

Interface	osid.authorization.AuthorizationProfile
Implements	`osid.OsidProfile`
Description	The `AuthorizationProfile` describes the interoperability among authorization 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	supportsAuthorization
Description	Tests for the availability of an authorization service which is the basic service for checking authorizations.
Return	`boolean`		`true` if authorization is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationLookup
Description	Tests if an authorization lookup service is supported. An authorization lookup service defines methods to access authorizations.
Return	`boolean`		true if authorization lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationQuery
Description	Tests if an authorization query service is supported.
Return	`boolean`		`true` if authorization query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationSearch
Description	Tests if an authorization search service is supported.
Return	`boolean`		`true` if authorization search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationAdmin
Description	Tests if an authorization administrative service is supported.
Return	`boolean`		`true` if authorization admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationNotification
Description	Tests if authorization notification is supported. Messages may be sent when authorizations are created, modified, or deleted.
Return	`boolean`		`true` if authorization notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationVault
Description	Tests if an authorization to vault lookup session is available.
Return	`boolean`		`true` if authorization vault lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationVaultAssignment
Description	Tests if an authorization to vault assignment session is available.
Return	`boolean`		`true` if authorization vault assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationSmartVault
Description	Tests if an authorization smart vaulting session is available.
Return	`boolean`		`true` if authorization smart vaulting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionLookup
Description	Tests if a function lookup service is supported. A function lookup service defines methods to access authorization functions.
Return	`boolean`		`true` if function lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionQuery
Description	Tests if a function query service is supported.
Return	`boolean`		`true` if function query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionSearch
Description	Tests if a function search service is supported.
Return	`boolean`		`true` if function search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionAdmin
Description	Tests if a function administrative service is supported.
Return	`boolean`		`true` if function admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionNotification
Description	Tests if function notification is supported. Messages may be sent when functions are created, modified, or deleted.
Return	`boolean`		`true` if function notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionVault
Description	Tests if a function to vault lookup session is available.
Return	`boolean`		`true` if function vault lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionVaultAssignment
Description	Tests if a function to vault assignment session is available.
Return	`boolean`		`true` if function vault assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionSmartVault
Description	Tests if a function smart vaulting session is available.
Return	`boolean`		`true` if function smart vaulting is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierLookup
Description	Tests if a qualifier lookup service is supported. A function lookup service defines methods to access authorization qualifiers.
Return	`boolean`		`true` if qualifier lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierQuery
Description	Tests if a qualifier query service is supported.
Return	`boolean`		`true` if qualifier query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierSearch
Description	Tests if a qualifier search service is supported.
Return	`boolean`		`true` if qualifier search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierAdmin
Description	Tests if a qualifier administrative service is supported.
Return	`boolean`		`true` if qualifier admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierNotification
Description	Tests if qualifier notification is supported. Messages may be sent when qualifiers are created, modified, or deleted.
Return	`boolean`		`true` if qualifier notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierHierarchy
Description	Tests if a qualifier hierarchy traversal is supported.
Return	`boolean`		`true` if a qualifier hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierHierarchyDesign
Description	Tests if qualifier hierarchy design is supported.
Return	`boolean`		`true` if a qualifier hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierVault
Description	Tests if a qualifier to vault lookup session is available.
Return	`boolean`		`true` if qualifier vault lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierVaultAssignment
Description	Tests if a qualifier to vault assignment session is available.
Return	`boolean`		`true` if qualifier vault assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierSmartVault
Description	Tests if a qualifier smart vaulting session is available.
Return	`boolean`		`true` if qualifier smart vault session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultLookup
Description	Tests if a vault lookup service is supported. A vault lookup service defines methods to access authorization vaults.
Return	`boolean`		`true` if function lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultQuery
Description	Tests if a vault query service is supported.
Return	`boolean`		`true` if vault query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultSearch
Description	Tests if a vault search service is supported.
Return	`boolean`		`true` if vault search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultAdmin
Description	Tests if a vault administrative service is supported.
Return	`boolean`		`true` if vault admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultNotification
Description	Tests if vault notification is supported. Messages may be sent when vaults are created, modified, or deleted.
Return	`boolean`		`true` if vault notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultHierarchy
Description	Tests if a vault hierarchy traversal is supported.
Return	`boolean`		`true` if a vault hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultHierarchyDesign
Description	Tests if vault hierarchy design is supported.
Return	`boolean`		`true` if a function hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizatinBatch
Description	Tests if an authorization batch service is supported.
Return	`boolean`		`true` if an authorization batch service design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizatinRules
Description	Tests if an authorization rules service is supported.
Return	`boolean`		`true` if an authorization rules service design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationRecordTypes
Description	Gets the supported `Authorization` record types.
Return	`osid.type.TypeList`		a list containing the supported authorization record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationRecordType
Description	Tests if the given authorization record type is supported.
Parameters	`osid.type.Type`	`authorizationRecordType`	a `Type` indicating an authorization record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`authorizationRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationSearchRecordTypes
Description	Gets the supported `Authorization` search record types.
Return	`osid.type.TypeList`		a list containing the supported authorization search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationSearchRecordType
Description	Tests if the given authorization search record type is supported.
Parameters	`osid.type.Type`	`authorizationSearchRecordType`	a `Type` indicating an authorization search record type
Return	`boolean`		`true` if the given search record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`authorizationSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionRecordTypes
Description	Gets the supported `Function` record types.
Return	`osid.type.TypeList`		a list containing the supported `Function` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionRecordType
Description	Tests if the given `Function` record type is supported.
Parameters	`osid.type.Type`	`functionRecordType`	a `Type` indicating a `Function` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`functionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFunctionSearchRecordTypes
Description	Gets the supported `Function` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Function` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFunctionSearchRecordType
Description	Tests if the given `Function` search record type is supported.
Parameters	`osid.type.Type`	`functionSearchRecordType`	a `Type` indicating a `Function` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`functionSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierRecordTypes
Description	Gets the supported `Qualifier` record types.
Return	`osid.type.TypeList`		a list containing the supported `Qualifier` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierRecordType
Description	Tests if the given `Qualifier` record type is supported.
Parameters	`osid.type.Type`	`qualifierRecordType`	a `Type` indicating a `Qualifier` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`qualifierRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQualifierSearchRecordTypes
Description	Gets the supported `Qualifier` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Qualifier` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsQualifierSearchRecordType
Description	Tests if the given `Qualifier` search record type is supported.
Parameters	`osid.type.Type`	`qualifierSearchRecordType`	a `Type` indicating a `Qualifier` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`qualifierSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVaultRecordTypes
Description	Gets the supported `Vault` record types.
Return	`osid.type.TypeList`		a list containing the supported `Vault` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultRecordType
Description	Tests if the given `Vault` record type is supported.
Parameters	`osid.type.Type`	`vaultRecordType`	a `Type` indicating a `Vault` type
Return	`boolean`		`true` if the given vault record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`vaultRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getVaultSearchRecordTypes
Description	Gets the supported vault search record types.
Return	`osid.type.TypeList`		a list containing the supported `Vault` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsVaultSearchRecordType
Description	Tests if the given vault search record type is supported.
Parameters	`osid.type.Type`	`vaultSearchRecordType`	a `Type` indicating a `Vault` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`vaultSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationConditionRecordTypes
Description	Gets the supported `AuthorizationCondition` record types.
Return	`osid.type.TypeList`		a list containing the supported `AuthorizationCondition` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsAuthorizationConditionRecordType
Description	Tests if the given `AuthorizationCondition` record type is supported.
Parameters	`osid.type.Type`	`authorizationConditionRecordType`	a `Type` indicating an `AuthorizationCondition` record type
Return	`boolean`		`true` if the given authorization condition record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`authorizationConditionRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.