OSID - osid.profile.ProfileEntry Service Interface Definition

Interface	osid.profile.ProfileEntry
Implements	`osid.OsidRelationship`
Used By	`osid.profile.ProfileEntryAdminSession`
	`osid.profile.ProfileEntryList`
	`osid.profile.ProfileEntryLookupSession`
Description	A ProfileEntry is a mapping among an `Agent` or `Resource` , and a `ProfileItem` . This interface is not required for performing a profile check but is used for examining and managing profiles. The actor of a profile may be specified in a variety of forms. `Agent` `Resource` : all `Agents` associated with a `Resource` for matching profiles An explicit `ProfileEntry` represents the mappings as they are specified in the profile provdier. Implicit profile entries may be retrieved which are profile entries inferred through the `ProfileItem` hierarchy. An implicit `ProfileEntry` is one where `isImplicit()` is true and should not be used for modification as it is only available for auditing purposes. An `ProfileEntry` containing a `Resource` may also provide the associated `Agent` in a request for implicit profiles or for all the profiles, both explicit and implicit, for a given `Agent` .
Method	isImplicit
Description	Tests if this profile entry is implicitly generated.
Return	`boolean`		`true` if this profile entry is implicit, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	hasResource
Description	Tests if this profile entry has a `Resource` .
Return	`boolean`		`true` if this profile entry has a `Resource` , `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceId
Description	Gets the `resource Id` for this profile entry.
Return	`osid.id.Id`		the `Resource Id`
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the `Resource` for this profile ebtry.
Return	`osid.resource.Resource`		the `Resource`
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAgent
Description	Tests if this profile entry has an `Agent` .An implied profile entry may have an `Agent` in addition to a specified `Resource` .
Return	`boolean`		`true` if this profile entry has an `Agent` , `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentId
Description	Gets the `Agent Id` for this profile entry.
Return	`osid.id.Id`		the `Agent Id`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAgent
Description	Gets the `Agent` for this profile entry.
Return	`osid.authentication.Agent`		the `Agent`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemId
Description	Gets the `ProfileItem` `Id` for this profile entry.
Return	`osid.id.Id`		the profile item `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItem
Description	Gets the `ProfileItem` for this profile entry.
Return	`osid.profile.ProfileItem`		the profile item
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryRecord
Description	Gets the proile entry record corresponding to the given `ProfileEntry` record `Type` . This method ie used to retrieve an object implementing the requested record. The `profileEntryRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(profileEntryRecordType)` is `true` .
Parameters	`osid.type.Type`	`profileEntryRecordType`	the type of the record to retrieve
Return	`osid.profile.records.ProfileEntryRecord`		the profile entry record
Errors	NULL_ARGUMENT		`profileEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(profileEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.