com.ibm.websphere.fabric.da
Class CandidateItem

java.lang.Object
  extended by com.ibm.websphere.fabric.da.CandidateItem
All Implemented Interfaces:
java.io.Serializable

public abstract class CandidateItem
extends java.lang.Object
implements java.io.Serializable

Version:
$Id: $
Author:
dranatunga
See Also:
Serialized Form

Constructor Summary
CandidateItem()
           
 
Method Summary
abstract  java.lang.String getAddress()
           
abstract  CompositePolicy getAdvertisedCapabilities()
           
abstract  Cost getCost()
           
 java.lang.String getEndpointId()
          Gets the ID used to group metadata about this endpoint in the BSR.
abstract  Score getMatchingScore()
           
 java.util.Collection getRejectReasons()
          Gets the list of all (if any) reasons why this candidate has been rejected.
abstract  ResolutionParameters getResolutionParameters()
          provides details of the indirect address's resolution parameters.
abstract  int getTier()
          Gets the most recent tier that this endpoint has been bucketed into.
 boolean isIndirect()
          logically abstract API determining whether this candidate represents an indirect endpoint that is resolved to zero or more actual endpoints at runtime.
abstract  boolean isRejected()
           
abstract  void reject(java.lang.String reasonDescription)
           
abstract  void setTier(int tier)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CandidateItem

public CandidateItem()
Method Detail

getEndpointId

public java.lang.String getEndpointId()
Gets the ID used to group metadata about this endpoint in the BSR.

Returns:
should not be null. (But default implementation returns null!)
Since:
WBSF 6.1

getAddress

public abstract java.lang.String getAddress()

getCost

public abstract Cost getCost()

getMatchingScore

public abstract Score getMatchingScore()

getAdvertisedCapabilities

public abstract CompositePolicy getAdvertisedCapabilities()

reject

public abstract void reject(java.lang.String reasonDescription)

isRejected

public abstract boolean isRejected()

getRejectReasons

public java.util.Collection getRejectReasons()
Gets the list of all (if any) reasons why this candidate has been rejected.

Returns:
non-null possibly empty collection of Strings.
Since:
WBSF 6.1

setTier

public abstract void setTier(int tier)

getTier

public abstract int getTier()
Gets the most recent tier that this endpoint has been bucketed into.

Returns:
a non-negative number if a tier has been set; a negative number otherwise.
Since:
WBSF 6.1

isIndirect

public boolean isIndirect()
logically abstract API determining whether this candidate represents an indirect endpoint that is resolved to zero or more actual endpoints at runtime. Default is false for backward compatibility.

Since:
WBSF 6.1.2

getResolutionParameters

public abstract ResolutionParameters getResolutionParameters()
provides details of the indirect address's resolution parameters.

Returns:
something if this is an indirect address; null otherwise.
Since:
WBSF 6.1.2
See Also:
isIndirect()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2002-2009 IBM. All Rights Reserved.