Interface IdLocator
-
@API public interface IdLocatorResponsible for identifying objects requested by the client of a configurable REST web service. The interface has a number of sub-classes, each of them contains a separate strategy for identifying objects, e.g. using a query.The strategy determines which parameters it requires.
- Since:
- 2015.3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default StatusDatagetIfNotFoundStatus()java.util.Collection<java.lang.String>locateIds(ExecutionCtx ctx)Locates object id/s based on the provided input.
-
-
-
Method Detail
-
locateIds
java.util.Collection<java.lang.String> locateIds(ExecutionCtx ctx) throws IdLocatorException
Locates object id/s based on the provided input.- Parameters:
ctx- Information about this REST call- Returns:
- The object id/s
- Throws:
IdLocatorException- Thrown if problem occur. For example, if no object was found.- Since:
- 2015.3.0
-
getIfNotFoundStatus
default StatusData getIfNotFoundStatus()
-
-