OSID - osid.resource.Resource Service Interface Definition

Interface	osid.resource.Resource
Implements	`osid.OsidObject`
Used By	`osid.OsidRequest`
	`osid.OsidRuleApplicator`
	`osid.Sourceable`
	`osid.acknowledgement.Credit`
	`osid.assessment.AssessmentTaken`
	`osid.authorization.Authorization`
	`osid.bidding.Auction`
	`osid.bidding.Bid`
	`osid.billing.Customer`
	`osid.billing.payment.Payer`
	show 61 more…
`osid.blogging.Entry`
`osid.calendaring.Commitment`
`osid.commenting.Comment`
`osid.contact.Address`
`osid.contact.Contact`
`osid.course.chronicle.AssessmentEntry`
`osid.course.chronicle.AwardEntry`
`osid.course.chronicle.CourseEntry`
`osid.course.chronicle.CredentialEntry`
`osid.course.chronicle.ProgramEntry`
`osid.course.program.Enrollment`
`osid.course.registration.ActivityRegistration`
`osid.course.registration.CourseRegistration`
`osid.course.registration.Registration`
`osid.course.registration.request.RegistrationRequestItem`
`osid.financials.Activity`
`osid.forum.Post`
`osid.forum.Reply`
`osid.grading.GradeEntry`
`osid.hold.Hold`
`osid.inquiry.Response`
`osid.installation.InstallationPackage`
`osid.inventory.Model`
`osid.inventory.shipment.Shipment`
`osid.journaling.JournalEntry`
`osid.learning.Proficiency`
`osid.logging.LogEntry`
`osid.mapping.ResourceLocation`
`osid.mapping.path.ResourceVelocity`
`osid.mapping.route.RouteProgress`
`osid.messaging.Message`
`osid.messaging.Receipt`
`osid.offering.Participant`
`osid.ordering.Order`
`osid.ordering.Price`
`osid.profile.ProfileEntry`
`osid.provisioning.Provision`
`osid.provisioning.ProvisionReturn`
`osid.provisioning.Provisionable`
`osid.provisioning.Request`
`osid.provisioning.RequestTransaction`
`osid.recognition.Conferral`
`osid.repository.Asset`
`osid.resource.ResourceAdminSession`
`osid.resource.ResourceAgentSession`
`osid.resource.ResourceList`
`osid.resource.ResourceLookupSession`
`osid.resource.ResourceNode`
`osid.resource.ResourceRelationship`
`osid.resourcing.Availability`
`osid.resourcing.Commission`
`osid.resourcing.Effort`
`osid.room.squatting.Deed`
`osid.room.squatting.Lease`
`osid.subscription.Subscription`
`osid.tracking.Issue`
`osid.voting.Candidate`
`osid.voting.RaceResult`
`osid.voting.Vote`
`osid.voting.VoterAllocation`
`osid.workflow.event.WorkflowEvent`
Description	A `Resource` represents an arbitrary entity. Resources are used to define an object to accompany an OSID `Id` used in other OSIDs. A resource may be used to represent a meeting room in the Scheduling OSID, or a student in the Course OSID. A `Resource` may also represent a group or organization. A provider may present such a group in an opaque manner through a single resource definition, or the provider may expose the resource collection for examination or manipulation. If such a resource collection is visible, `isGroup()` is `true` and can be used in one of the group sessions available in this OSID.
Method	isGroup
Description	Tests if this resource is a group. A resource that is a group can be used in the group sessions.
Return	`boolean`		`true` if this resource is a group, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isDemographic
Description	Tests if this resource is a demographic. A resource that is a demographic can be used in the demographic service and the group sessions.
Return	`boolean`		`true` if this resource is a demographic, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	hasAvatar
Description	Tests if this resource has an avatar.
Return	`boolean`		`true` if this resource has an avatar, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAvatarId
Description	Gets the asset `Id`.
Return	`osid.id.Id`		the asset `Id`
Errors	ILLEGAL_STATE		`hasAvatar()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAvatar
Description	Gets the asset.
Return	`osid.repository.Asset`		the asset
Errors	ILLEGAL_STATE		`hasAvatar()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getResourceRecord
Description	Gets the resource record corresponding to the given `Resource` record `Type`.This method is used to retrieve an object implementing the requested record. The `resourceRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(resourceRecordType)` is `true`.
Parameters	`osid.type.Type`	`resourceRecordType`	the resource record type
Return	`osid.resource.records.ResourceRecord`		the resource record
Errors	NULL_ARGUMENT		`resourceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resourceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.