Interface Model

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Model
extends OsidObject

A Model represents a specific make of a product that is used to build a vocabulary of managed products.

Method Summary

Modifier and Type	Method	Description
String	getArchetype()	Gets the model name component (e.g.
Resource	getManufacturer()	Gets the manufacturer (e.g.
Id	getManufacturerId()	Gets the manufacturer Id .
ModelRecord	getModelRecord(Type modelRecordType)	Gets the model record corresponding to the given Model record Type .This method is used to retrieve an object implementing the requested record.
String	getNumber()	Gets the model number (e.g.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getManufacturerId

Id getManufacturerId()

Gets the manufacturer Id .

Returns:

a resource Id

Compliance:

mandatory - This method must be implemented.

getManufacturer

Resource getManufacturer()
                  throws OperationFailedException

Gets the manufacturer (e.g. Cisco).

Returns:

a resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getArchetype

String getArchetype()

Gets the model name component (e.g. ASR 9010)

Returns:

the model

Compliance:

mandatory - This method must be implemented.

getNumber

String getNumber()

Gets the model number (e.g. ASR-9010-AC-V2).

Returns:

the model number

Compliance:

mandatory - This method must be implemented.

getModelRecord

ModelRecord getModelRecord(Type modelRecordType)
                    throws OperationFailedException

Gets the model record corresponding to the given Model record Type .This method is used to retrieve an object implementing the requested record. The modelRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(modelRecordType) is true .

Parameters:

modelRecordType - the type of model record to retrieve

Returns:

the model record

Throws:

NullArgumentException - modelRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(modelRecordType) is false

Compliance:

mandatory - This method must be implemented.