oracle.panama.lbevent
Interface LBCriteria

public interface LBCriteria

A LBCriteria object represents a Location Based Criterion. A location based criterion has three components: 1. Target 2. Region 3. Type. If the type is LBCondition.TYPE_IN, when the target is inside the region or on the border of the region, the criterion is considered statisfied. If the tpe is LBCondition.TYPE_OUT, when the target is outside the region, the criterion is considered satisfied.

Method Summary

long	getConditionId() Get the id of the condition that this criterion belongs to.
java.lang.String	getCriteriaType() Get the type of the criterion
long	getRegionId() Get the id of the region
java.lang.String	getTarget() Get the target.
ModelObject	getTargetObj() Get the Model object that represents the target
java.lang.String	getTargetType() Get the type of the target
boolean	isValid() Check whether the criterion is valid or not.

Method Detail

getConditionId

public long getConditionId()

Get the id of the condition that this criterion belongs to.

getTarget

public java.lang.String getTarget()

Get the target.

Returns:

A string represent the target. If the target type is LBCondition.TARGETTYPE_USER, the return result is the string representation of the user id. If the target type is LBCondition.TARGETTYPE_COMM, the return result is the string representation of the community id. If the target type is LBCondition.TARGETTYPE_MSID, the return result is the MSID.

getTargetType

public java.lang.String getTargetType()

Get the type of the target

See Also:

LBCondition

getCriteriaType

public java.lang.String getCriteriaType()

Get the type of the criterion

See Also:

LBCondition

getRegionId

public long getRegionId()

Get the id of the region

getTargetObj

public ModelObject getTargetObj()
                         throws LBEventException

Get the Model object that represents the target

Returns:

If the target type is LBCondition.TARGETTYPE_USER, the return result is the user object. If the target type is LBCondition.TARGETTYPE_COMM, the return result is the community object. If the target type is LBCondition.TARGETTYPE_MSID, the return result is null.

LBEventException

isValid

public boolean isValid()

Check whether the criterion is valid or not. The criterion may become invalid if the target is deleted.