bbc.rd.tvanytime.contentReferencing
Class Result

java.lang.Object
  extended by bbc.rd.tvanytime.contentReferencing.Result
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class Result
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

Result: A TVAnytime Result object.

Version:
1.0
Author:
Tim Sargeant, BBC Research & Development, February 2003
See Also:
Serialized Form

Constructor Summary
Result()
          Constructor for objects of type Result.
Result(ContentReference crid, java.lang.String status, boolean complete, java.lang.String acquire)
          Constructor, with required attributes.
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 java.lang.String getAcquire()
          Get the acquire flag
 ContentReference getCRID()
          Get the CRID
 CRIDResult getCRIDResult()
          Get the CRIDResult.
 LocationsResult getLocationsResult()
          Get the LocationsResult.
 java.util.Date getReresolveDate()
          Get the reresolveDate
 java.lang.String getStatus()
          Get the status
 boolean isComplete()
          Is the resolution complete?
 void setAcquire(java.lang.String acquire)
          Set the complete flag
 void setComplete(boolean complete)
          Set the complete flag
 void setCRID(ContentReference crid)
          Set the CRID
 void setCRIDResult(CRIDResult cridResult)
          Set the CRIDResult
 void setLocationsResult(LocationsResult locationsResult)
          Set the LocationsResult
 void setReresolveDate(java.util.Date reresolveDate)
          Set the reresolveDate
 void setStatus(java.lang.String status)
          Set the status flag
 java.lang.String toString()
          Returns string representation of this object.
 java.lang.String toString(int indent)
          Returns string representation of this object.
 java.lang.String toXML()
          Returns XML representation of this object.
 java.lang.String toXML(int indent)
          Returns XML representation of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Result

public Result()
Constructor for objects of type Result.


Result

public Result(ContentReference crid,
              java.lang.String status,
              boolean complete,
              java.lang.String acquire)
       throws TVAnytimeException
Constructor, with required attributes.

Parameters:
crid - The CRID.
status - Resolve status ("resolved", "discard CRID", "cannot yet resolve", "unable to resolve")
complete - is resolution complete?
acquire - Aquisition directive ("all", "any")
Throws:
TVAnytimeException - if status or acquire are invalid
Method Detail

setCRIDResult

public void setCRIDResult(CRIDResult cridResult)
Set the CRIDResult

Since CRIDResult and LocationsResult are an xsd:choice (can only have one or the other), setting CRIDResult forces any LocationsResult object to null

Parameters:
cridResult - the CRIDResult

setLocationsResult

public void setLocationsResult(LocationsResult locationsResult)
Set the LocationsResult

Since CRIDResult and LocationsResult are an xsd:choice (can only have one or the other), setting LocationsResult forces any CRIDResult object to null

Parameters:
locationsResult - the LocationsResult

setCRID

public void setCRID(ContentReference crid)
Set the CRID

Parameters:
crid - the CRID

setComplete

public void setComplete(boolean complete)
Set the complete flag

Parameters:
complete - the 'complete' flag

setAcquire

public void setAcquire(java.lang.String acquire)
                throws TVAnytimeException
Set the complete flag

Parameters:
acquire - the 'acquire' flag (must be "all" or "any")
Throws:
TVAnytimeException

setStatus

public void setStatus(java.lang.String status)
               throws TVAnytimeException
Set the status flag

Parameters:
status - the 'status' flag (must be "resolve", "discard CRID", "cannot yet resolve" or "unable to resolve")
Throws:
TVAnytimeException

setReresolveDate

public void setReresolveDate(java.util.Date reresolveDate)
Set the reresolveDate

Parameters:
reresolveDate - the reresolveDate for this Result

getCRID

public ContentReference getCRID()
Get the CRID

Returns:
crid the Result CRID

getLocationsResult

public LocationsResult getLocationsResult()
Get the LocationsResult. This will be null if this object contains a CRIDResult.

Returns:
lr the LocationsResult

getCRIDResult

public CRIDResult getCRIDResult()
Get the CRIDResult. This will be null if this object contains a LocationsResult.

Returns:
cr the CRIDResult

isComplete

public boolean isComplete()
Is the resolution complete?

Returns:
complete the Result complete flag

getAcquire

public java.lang.String getAcquire()
Get the acquire flag

Returns:
acquire the Result acquire flag

getStatus

public java.lang.String getStatus()
Get the status

Returns:
status the Result status

getReresolveDate

public java.util.Date getReresolveDate()
Get the reresolveDate

Returns:
reresolveDate the reresolveDate for this Result

toXML

public java.lang.String toXML()
Returns XML representation of this object.

Returns:
XML representation of this object.

toXML

public java.lang.String toXML(int indent)
Returns XML representation of this object.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
XML representation of the object.

toString

public java.lang.String toString()
Returns string representation of this object.

Overrides:
toString in class java.lang.Object
Returns:
String representation of this object.

toString

public java.lang.String toString(int indent)
Returns string representation of this object.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
string representation of the object.

clone

public java.lang.Object clone()
Clones itself.

Overrides:
clone in class java.lang.Object
Returns:
A copy of itself.