|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Advice
This interface is used to return advice from the Advisor. Advice can consist of a number of namespaces (one for each Advislet) each of which can contain a list of key-value pairs, that contain sub-results for the Advice.
Advice is considered complete if isComplete returns true and there are no ProcessingErrors associated with the Advice.
Method Summary | |
---|---|
void |
addProcessingError(ProcessingError error)
Adds an error that ocurred while processing an AdviceRequest |
Object |
getEntry(Advislet advislet,
Object key)
Retrieves an entry from an Advislet's namespace. |
String |
getIdentifier()
Get the identifier for the Advice. |
ProcessingError[] |
getProcessingErrors()
Get the ProcessingErrors which occured while creating the Advice. |
Object |
getResult()
Returns the last RESULT key written to the Advice. |
Object |
getResult(Advislet advislet)
Get the object with the RESULT key for an Advislet. |
boolean |
isComplete()
Returns the completion status for the Advice. |
void |
setEntry(Advislet advislet,
Object key,
Object value)
Sets an entry within an Advislet's namespace. |
void |
setIncomplete()
Marks this Advice object as incomplete. |
void |
setResult(Advislet advislet,
Object value)
Sets the result within an Advislet's namespace. |
Method Detail |
---|
Object getEntry(Advislet advislet, Object key)
advislet
- the Advislet namespace to be queriedkey
- the key for the value within the namespace
void setEntry(Advislet advislet, Object key, Object value)
advislet
- the Advislet namespace to be modifedkey
- the key for the Advice sub-result being added.value
- the value to be associated with the keyvoid setResult(Advislet advislet, Object value)
advislet
- the Advislet namespace to be modifedvalue
- the result valueString getIdentifier()
ProcessingError[] getProcessingErrors()
void addProcessingError(ProcessingError error)
error
- the ProcessingError to be added.boolean isComplete()
void setIncomplete()
Object getResult(Advislet advislet)
advislet
- The target Advislet
Object getResult() throws IllegalStateException
IllegalStateException
- if isComplete
returns false
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |