iaik.xkms
Interface QueryKeyBinding

All Superinterfaces:
XKeyBindingAbstractType

public interface QueryKeyBinding
extends XKeyBindingAbstractType

A template used to specify one or more key bindings using query by example.

[211] The <QueryKeyBinding> element is derived from the XKeyBindingAbstractType and is used to perform a query that results in the return of one or more matching key bindings.

[212] A key binding matches the QueryKeyBinding if:
The key binding contains all the <UseKeyWith> elements contained in the query, and
The key binding contains all the <KeyInfo> elements contained in the query.

[213] The <QueryKeyBinding> element extends the XKeyBindingAbstractType with the following additional elements:
<TimeInstant> [Optional]
The Time Instant for which the query is made. If no time instant is specified the default is the time the request was made. A Service that does not support the TimeInstant element MUST return a 'Receiver.TimeInstantNotSupported' result. Additionally, a Service that does support the TimeInstant element may be unable or unwilling to respond to requests indicating a time instant that is outside a certain range. In such cases, the service MUST return a 'Sender.TimeInstantOutOfRange' result.

[215] The <TimeInstant> element specifies a specific instant in time for which a key binding query is made.

[216] All dateTime values MUST fully specify the date.


Method Summary
 Calendar getTimeInstant()
          Gets TimeInstant of this QueryKeyBinding.
 void setTimeInstant(Calendar cal)
          Sets TimeInstant of this QueryKeyBinding to the supplied value.
 
Methods inherited from interface XKeyBindingAbstractType
addKeyUsage, addUseKeyWith, addUseKeyWith, getId, getKeyInfo, getKeyUsage, getUseKeyWithList, getUseKeyWithSize, removeKeyUsage, setId, setKeyInfo
 

Method Detail

setTimeInstant

void setTimeInstant(Calendar cal)
Sets TimeInstant of this QueryKeyBinding to the supplied value.

Parameters:
cal - new value for the TimeInstant of this QueryKeyBinding
Throws:
XKMSException

getTimeInstant

Calendar getTimeInstant()
Gets TimeInstant of this QueryKeyBinding.

Returns:
TimeInstant of this QueryKeyBinding