semi合集-English.pdf - 第1672页

SEMI E39-0703 © SEMI 1995, 2003 14 Parameter Definition Form ErrorCode Contains the code for the specific error found. Enumerated: Unknown Object in Object Specifier Unknown Target Object Type Unknown Object Instance Unk…

100%1 / 7923
SEMI E39-0703 © SEMI 1995, 2003 13
11.2.3 Object type may be omitted from the object
specifier where it may be otherwise determined without
ambiguity. However, inclusion of type is always valid.
11.3 Filtering — An attribute filter is an optional set of
one or more attribute qualifications. An attribute
qualification is a boolean expression that makes a
statement about the presence or values of attributes in a
target object. It identifies an attribute, a qualifying value
of that attribute, and a qualifying relationship that the
value has to the target attribute. The attribute filter is a
boolean that consists of the expression formed by an
AND of the set of qualifications.
11.3.1 If the attribute is of text form, the qualifying
value may be used as a mask with the embedded wild
characters “? ” (question mark) and “*” (asterisk). The
character “? ” may be used within the mask to represent
“any single character” and may be repeated. The string
“? ? ? ? ? ” represents any text string with a length of five
characters.
11.3.2 The character “*” may be used in the mask to
represent a variable-length string, including a null
string. The string “*x” represents a string of any length
that ends in “x”; the string “x*” represents any string
that begins with “x”.
11.3.3 When the character “*” is used by itself as the
string “*”, however, it represents any string of any non-
zero length. It may also be repeated within a string, as
in “*x*y*”, which represents any string with embedded
characters “x” and “y”, such as “abxaby”, “x_y”, and
“xy”.
11.3.4 The comparison for text characters shall be case
insensitive.
11.3.5 The qualifying value specifies a qualifying
relationship, “R”, between the value specified in the
attribute qualification and the matching attribute of
object instances. The qualifying value for the attribute
is compared with the attribute of an instance of the
target object to test the relationship.
11.3.6 If the qualifying value has the relationship “R”
to the attribute of the target object, then the instance
qualifies for the relationship and is included in the set
of objects for which requested attributes are returned.
For example, if the attribute name is “Length,”
qualifying value is the number 5, and the qualifying
relationship is “is less than,” then the Length attributes
of all instances of the target object are tested. All
instances with a “Length” attribute greater than 5 or
equal to 5 qualify.
11.4 Object Services Parameter Dictionary — Table 3
defines all of the parameters, including the elements of
complex parameters, used in object services.
Table 3 Object Services Parameter Dictionary
Parameter Definition Form
AttrData The value of an attribute. Varies with attribute. The form of an attribute' s value is specified as
part of the definition of an object type.
AttrFilter Attribute filter. Structure composed of AttrName, AttrData, AttrReln.
AttrName The attribute' s name. Text. Varies with object type.
AttrReln Qualifying relationship
between the qualifying value
and the matching attribute of
object instances.
Enumerated:
Equal To
Not Equal To
Less Than
Less Than or Equal To
Greater Than
Greater Than or Equal To
Present (specified attribute is present)
Absent (specified attribute is absent)
Contained (The qualifying value is in (i.e., equal to a member of)
the set of the attribute’s values.)
Not Contained (If omitted, the relationship " Equal to" is assumed.)
AttrSetting The name and value of an
attribute.
Structure composed of AttrName and AttrData.
SEMI E39-0703 © SEMI 1995, 2003 14
Parameter Definition Form
ErrorCode Contains the code for the
specific error found.
Enumerated:
Unknown Object in Object Specifier
Unknown Target Object Type
Unknown Object Instance
Unknown Attribute Name
Read-Only Attribute — Access Denied
ErrorText Text in support of the error
code to provide additional
information.
Text.
ObjAck Acknowledgement code. Unsigned integer. Possible values:
Successful completion of request
Error
ObjectAction The name of an action to be
performed on, or by, an object.
Text. Enumerated per individual object.
ObjectAction
Acknowledgement
Status of action request. Enumerated:
Action was performed successfully.
Action does not exist.
Cannot perform now – try later.
Action will be performed and notification sent later.
Action is prohibited.
Target object unknown.
ObjectActionParameter
Request
Structure composed of a name
and a value for a given object
parameter used in the request.
Structure of ServiceParameterName and ServiceParameterValue.
ObjectActionParameter
Result
Structure composed of a name
and a value for given object
parameter used in the result.
Structure of ServiceParameterName and ServiceParameterValue.
ObjectActionReportStatus Status of receipt of an
ObjectActionComplete-
Notification.
Binary.
ObjectActionStatus Result of the action request. Structure of ObjectActionAcknowledgement and Status.
ObjectLinkID Set to non-zero if and only if
additional completion reports
will be sent.
Unsigned integer.
ObjectServiceList Specified the services
supported by a given object
type.
Structure composed of ObjType, ServiceName.
ObjID Object identifier (ObjID). Varies with object type.
ObjSetting Attribute values for an object
instance.
Structure composed of ObjID and (List of) AttrSetting.
ObjSpec The object specifier, used to
specify the owner of the target
object.
Formatted text.
ObjStatus Information concerning the
success or failure of the
operation.
Structure consisting of ObjAck and Status.
ObjType Object type. Object types are text strings reserved by individual standards. Object
Services do not reserve object types.
OperationID Identifies a specific request. Unsigned Integer.
ServiceName The name of a service or action
to be performed on, or by, an
object.
Text.
ServiceParameterDef A structure of a service name
and a list of the
p
arameter
A structure of ServiceName and associated list of
ServiceParameterNames.
SEMI E39-0703 © SEMI 1995, 2003 15
Parameter Definition Form
names that are supported by an
object type.
ServiceParameterName Parameter name. Text.
ServiceParameterValue Parameter value. Any. Varies depending on the parameter.
Status Error information. (List of) Structure composed of ErrorCode and ErrorText.
11.5 Get and Set Attributes — The GetAttr and SetAttr
services are provided for reading and setting values of
an object' s attributes. They address attribute values of
instances of objects. Figures 7 and 8 show the message
flow for the GetAttr service.
Figure 7
GetAttr Message Flow
Figure 8
SetAttr Message Flow
11.5.1 GetAttr and SetAttr allow access to attributes of
objects that are owned by another object and are
capable of addressing multiple levels of ownership
(object hierarchy).
11.5.1.1 For example, GetAttr may be used as a “get
directory” request to find the identifiers of all instances
of one or more owned objects.
11.5.2 GetAttr and SetAttr may be used for objects that
use a complex identifier, such as recipes with separate
attributes for name and version.
11.5.3 GetAttr and SetAttr allow searching for those
instances of an object that satisfy certain conditions
through the specification of one or more qualifiers or
filters. Only attributes of those instances of the desired
object type that satisfy the conditions defined in the
filters are returned by the service provider.
11.5.3.1 The filter is familiar to users of file services as
a convenient way to obtain a partial directory of files,
such as files with a date later than a specified date. This
is particularly useful when the list of contents may be
quite long.
11.5.4 The attribute value (all or a part of the list of
ObjSetting) returned by the GetAttr service may be
invalid if the acknowledge code of ObjStatus indicates
a failure. In that case; the value(s) requested by the
invocation of GetAttr service may be unknown, invalid
or unavailable by any reason (e.g. corresponding
hardware status, lack of privilege, mutual exclusion or
other requirement not fulfilled by the application).
Supplier shall document all conditions or timing
requirements of any attributes if they are not always
available.
11.5.5 The attribute value (all or a part of the list of
ObjSetting) replied by the SetAttr service may be still
unchanged if the acknowledge code of ObjStatus
indicates a failure. In that case; the attribute value may
be unchangeable, inhibited or blocked internally by any
reason (e.g. corresponding hardware status, lack of
privilege, mutual exclusion or other requirement not
fulfilled by the application. The object providing the
SetAttr service shall identify whether or not it is valid
to change or set an attribute value. Supplier shall
document all conditions and timing requirements of
each attribute if they are not always allowed to be set.
11.5.6 Object Specifier — This parameter is used for
specifying an owner object and may be omitted from
the message. When included, it is a formatted text
string that conforms to the description in Section 9. An
object specifier is rejected by service providers that do
not use owner or owned objects.
11.5.7 Filter — This is a optional list of qualifications
to be applied to specifed attribute and may be omitted
from the message. When included, the complete filter is
formed by a logical AND of each attribute qualification
in the list.
11.5.8 Requested Attribute — The final parameter in
the GetAttr service gives the names of one or more
attributes of interest. These are the attributes whose
values shall be returned in the response, in the order
requested.
11.5.9 Settings — In the SetAttr service, a list of one or
more attribute name/value pairs is specified. This is the
set of desired attribute values. SetAttr rejects any
attempt to set a read-only attribute and returns