|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResolutionResponse
Interface for encapsulating a resolution response. A resolution function call will return an object which implements this interface
All the searching through the local database and possibly multiple IP servers is done transparently.
There are 4 states that an application needs to distinguish:
1 | 2 | 3 | 4 | |
---|---|---|---|---|
isValid() | true | true | true | false |
isSuccessful() | true | true | false | undefined |
isCompletelyResolved() | true | false | false | undefined |
getChildren() | Vector | Vector | null | null |
getNextResolutionDate() | null | Date or null | Date or null | null |
getType() | TYPE_GET_ALL or TYPE_ALTERNATIVE
| TYPE_GET_ALL or TYPE_ALTERNATIVE | undefined | undefined |
Note that resolution authorities are never returned as a possible response. The redirection mechanism is automatically followed. In other words, a client of this class does not need to know about Resolving Authority Records, nor the various Resolution handlers that are used to carry out the resolution.
Field Summary | |
---|---|
static int |
TYPE_ALTERNATIVE
Value returned by getType which indicates that just one of the children should be captured. |
static int |
TYPE_GET_ALL
Value returned by getType which indicates that all the children should be captured. |
Method Summary | |
---|---|
java.util.Vector |
getChildren()
This method provides access to the resolution results. |
java.util.Date |
getNextResolutionDate()
If the resolution was not successful, or successful but incomplete, this function may indicate when an application should try to resolve again. |
CRID |
getQueryCRID()
Returns the Content Reference that was used in the query which created this response. |
int |
getSource()
Get the source of this resolution response. |
int |
getType()
Signals how the list of children should be handled. |
boolean |
hasCRIDChildren()
Returns true if this response is for a group CRID that has CRIDs as its children. |
boolean |
isCompletelyResolved()
Used to indicate whether or not further resolution is required. |
boolean |
isSuccessful()
Used to indicate whether or not the Content Reference was successfully resolved. |
boolean |
isValid()
Used to indicate whether or not a valid response has been obtained. |
Field Detail |
---|
static final int TYPE_GET_ALL
getType
which indicates that all the children should be captured.
e.g. this would be used for a series.
static final int TYPE_ALTERNATIVE
getType
which indicates that just one of the children should be captured.
e.g. this would be used for a programme and its repeat.
Method Detail |
---|
boolean isValid()
boolean isSuccessful()
boolean isCompletelyResolved()
CRID getQueryCRID()
CRID
objectjava.util.Vector getChildren()
instanceof
operator the client can determine the
type of object that each element of the vector contains.
boolean hasCRIDChildren()
hasCRIDChildren
returns true
, then the getChildren
call will
return a Vector that only contains CRID objects. If hasCRIDChildren
returns
false
, the getChildren
function will return a Vector of ContentLocation
objects, or the getChildren
call will return an empty Vector.
java.util.Date getNextResolutionDate()
int getType()
TYPE_GET_ALL
or
TYPE_ALTERNATIVE
int getSource()
RESOLVE_LOCAL
, RESOLVE_DVB
, or RESOLVE_IP
as defined
in the ContentReferencingManager
class that identifies the source of this
resolution response.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |