com.neurosys.q.service

Interface ShiftService<S extends Shift<T>,V,P,T extends Token<T>>

Type Parameters:

S - as Shift

V - as Venue

P - as PlaceRef

T - as Token

All Superinterfaces:

TokenContainerService<T,S>

public interface ShiftService<S extends Shift<T>,V,P,T extends Token<T>>
extends TokenContainerService<T,S>

Manage Shifts

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
S	create(V venue, P place, Date startDateTime, User shiftOwner, String shiftDisplayName, ShiftStatus overrideDefaultStatus) Create a shift/scheduled but dont start it
S	determineRoute(T token) Determine Shift for a given Token
void	end(S shift)
List<S>	findInActiveShifts(Object o, Predicate<S> filter, boolean activeTokensOnly) For an object like user/consumer find the shifts they are in, across all Shifts of type <S>
List<T>	findTokensInActiveShifts(Object o, Predicate<S> filter, boolean activeTokensOnly) For an object like user/consumer find the tokens across all Shifts of type <S>
S	getActiveShift(String name) Get an Active Shift by its name
S	getActiveShift(V venue, P place, String shiftDisplayName) Get current/ShiftStatus.ACTIVE Shifts for the Venue and PlaceRef This method may throw an exception (impl dependent), if the system maintains more than one active Shift for any location.
List<S>	getActiveShifts() Get all current ShiftStatus.ACTIVE Shifts in System
List<S>	getActiveShifts(V venue) Get all current ShiftStatus.ACTIVE Shifts for the Venue
List<S>	getActiveShifts(V venue, P place) Get all current ShiftStatus.ACTIVE Shifts for the Venue and PlaceRef
default S	getAssignedContainer(T token) For a Token get the container
S	getAssignedShift(T token) For a Token determine its assigned Shift.
<DAO> DAO	getDao() Get any DAO backing this service
T	getFirstToken(S shift, Collection states) Get the first token for a group of status
List<T>	getInProcess(S tokenContainer) Tokens that out of the Q but being processed
T	getLastToken(S shift, Collection states) In Some situations a token may need to be put end of Q in a particular State(s).
List<T>	getNextReadyToProcessTokens(T token, int n) Get the next N tokens for tokens in the Same Shift that are Ready to be processed.
List<T>	getPreProcess(S tokenContainer) Tokens that are not yet eligible to be in Q but are being considered.
List<T>	getProcessed(S tokenContainer) Tokens that out of the Q and processed
List<T>	getReadyToBeProcessed(S tokenContainer, T lastToken) Get tokens ready to be processed; from lastToken (excluding it)
S	getScheduledShift(V venue, P place, String shiftDisplayName) Get next scheduled Shift
List<S>	getScheduledShifts(V venue, P place) Get all next scheduled Shifts for the Venue and PlaceRef
S	getShift(Object id) Get Shift from Id.
List<T>	getTokens(S shift) Get all Token
List<T>	getTokens(S shift, T afterToken, Collection states) Get all tokens since a last token (including it)
List<T>	getTokens(S shift, T afterToken, Collection states, PageInfo pageInfo) Get all tokens since a last token (including it)
List<T>	getTokens(S shift, T afterToken, T beforeToken, Collection states, PageInfo pageInfo) Get all tokens since a last token (including it)
List<T>	getTokensFrom(S shift, T token, Collection states) Get all Tokenss in sequence till (excluding) the token
List<T>	getTokensTill(S shift, T token, Collection states) Get all Tokenss in sequence till (excluding) the token
boolean	isActive(S shift) Check if a Shift is active or not
S	rename(S shift, String newDisplayName) Rename as Shift
S	reset(S shift) Reset/ReStart a new Shift based on data from an existing one.
S	start(S shift, String metaJSON) Start a created shift @ a Venue NOW.
default S	start(V venue, P place, AuthenticationToken authToken, String shiftDisplayName)
S	start(V venue, P place, AuthenticationToken authToken, String shiftDisplayName, String metaJSON) Start a Shift @ a Venue NOW

Methods inherited from interface com.neurosys.q.service.TokenContainerService

add, getMaxResultSize, getPositions, getQStatesStrategy, getSequence, getType, hasNext, init, linkTokens, lookup, lookupById, lookupBySequence, lookupBySequence, move, poll, poll, poll, poll, remove, save, size, update, updateStatus, updateStatus

Method Detail

start

S start(V venue,
        P place,
        AuthenticationToken authToken,
        String shiftDisplayName,
        String metaJSON)
 throws Exception

Start a Shift @ a Venue NOW

Parameters:

venue - as Venue

place - as PlaceRef within Venue

authToken - as AuthenticationToken

shiftDisplayName - as String (optional)

metaJSON - as String as JSON for optional Shift meta data. Like Client Clock Date/Time etc.

Returns:

Shift

Throws:

Exception - if Shift could not be created or started

start

default S start(V venue,
                P place,
                AuthenticationToken authToken,
                String shiftDisplayName)
         throws Exception

Throws:

Exception

start

S start(S shift,
        String metaJSON)
 throws Exception

Start a created shift @ a Venue NOW.

Parameters:

metaJSON - as String as JSON for optional Shift meta data. Like Client Clock Date/Time etc.

shift -

Returns:

Throws:

Exception - if Shift was not created earlier or could not be started

create

S create(V venue,
         P place,
         Date startDateTime,
         User shiftOwner,
         String shiftDisplayName,
         ShiftStatus overrideDefaultStatus)
  throws Exception

Create a shift/scheduled but dont start it

Parameters:

venue - as Venue

place - as PlaceRef within Venue

startDateTime - as Date as when the shift will start

shiftOwner - a User who owns/manages the shift (optional)

shiftDisplayName - as String (optional)

overrideDefaultStatus - as ShiftStatus. By default its ShiftStatus.SCHEDULED however on creation itself if we wish to override this; then explicitly pass the status or use start(Shift, String)

Returns:

Shift

Throws:

Exception - if the Shift could not be created

rename

S rename(S shift,
         String newDisplayName)
  throws Exception

Rename as Shift

Parameters:

shift - as Shift

newDisplayName - as String

Returns:

Shift

Throws:

Exception

end

void end(S shift)

Parameters:

shift -

Throws:

Exception - if shift already ended or was never started even (optional)

getShift

S getShift(Object id)

Get Shift from Id. One can use name or some other unique identifier also, however by default Id (Long) is the only one.

Parameters:

id - as Long

Returns:

getActiveShift

S getActiveShift(String name)

Get an Active Shift by its name

Parameters:

name - as String

Returns:

Shift type <S>

isActive

boolean isActive(S shift)

Check if a Shift is active or not

Parameters:

shift - as Shift

Returns:

getActiveShifts

List<S> getActiveShifts()

Get all current ShiftStatus.ACTIVE Shifts in System

Returns:

List of Shifts

getActiveShifts

List<S> getActiveShifts(V venue)

Get all current ShiftStatus.ACTIVE Shifts for the Venue

Parameters:

venue - as Venue

Returns:

List of Shifts

getActiveShifts

List<S> getActiveShifts(V venue,
                        P place)

Get all current ShiftStatus.ACTIVE Shifts for the Venue and PlaceRef

Parameters:

venue - as Venue

place - as PlaceRef return List of Shifts

getActiveShift

S getActiveShift(V venue,
                 P place,
                 String shiftDisplayName)

Get current/ShiftStatus.ACTIVE Shifts for the Venue and PlaceRef
This method may throw an exception (impl dependent), if the system maintains more than one active Shift for any location.

Parameters:

venue -

place -

shiftDisplayName - as String (nullable)

Returns:

Shift as type <S>

getScheduledShifts

List<S> getScheduledShifts(V venue,
                           P place)

Get all next scheduled Shifts for the Venue and PlaceRef

Parameters:

venue - as Venue

place - as PlaceRef

Returns:

List

getScheduledShift

S getScheduledShift(V venue,
                    P place,
                    String shiftDisplayName)

Get next scheduled Shift

Parameters:

venue -

place -

shiftDisplayName - as String (nullable)

Returns:

Shift as type <S>

determineRoute

S determineRoute(T token)
          throws TokenProcessingException

Determine Shift for a given Token

Parameters:

token -

Returns:

Throws:

TokenProcessingException

getTokens

List<T> getTokens(S shift,
                  T afterToken,
                  T beforeToken,
                  Collection states,
                  PageInfo pageInfo)

Get all tokens since a last token (including it)

Parameters:

shift - as Shift

afterToken - as Token type . @nullable true

beforeToken - as Token type . @nullable true

states - as Collection of status type objects (Optional. If not specified will search across all Status)

pageInfo - as PageInfo. nullable true.

Returns:

List of Tokens

getTokens

List<T> getTokens(S shift,
                  T afterToken,
                  Collection states,
                  PageInfo pageInfo)

Get all tokens since a last token (including it)

Parameters:

shift - as Shift

afterToken - as Token type . @nullable true

states - as Collection of status type objects (Optional. If not specified will search across all Status)

pageInfo - as PageInfo. nullable true.

Returns:

List of Tokens

getTokens

List<T> getTokens(S shift,
                  T afterToken,
                  Collection states)

Get all tokens since a last token (including it)

Parameters:

shift - as Shift

afterToken - as Token type . @nullable true

states - as Collection of status type objects (Optional. If not specified will search across all Status)

Returns:

List of Tokens

getLastToken

T getLastToken(S shift,
               Collection states)

In Some situations a token may need to be put end of Q in a particular State(s). So find out last token and place it after it.

Parameters:

shift - as Shift

states - as Collection of status type objects (Optional. If not specified will search across all Status)

Returns:

Token

Can be null:

true

getFirstToken

T getFirstToken(S shift,
                Collection states)

Get the first token for a group of status

Parameters:

shift - as Shift

states - as Collection of status type objects (Optional. If not specified will search across all Status)

Returns:

Token

Can be null:

true

getNextReadyToProcessTokens

List<T> getNextReadyToProcessTokens(T token,
                                    int n)

Get the next N tokens for tokens in the Same Shift that are Ready to be processed. (excluding it)

Parameters:

token - Token from whih the next tokens will be fetched.

n - as number of tokens from the front of the Shift

Returns:

List of Token

Can be null:

true

getTokensTill

List<T> getTokensTill(S shift,
                      T token,
                      Collection states)

Get all Tokenss in sequence till (excluding) the token

Parameters:

shift - as Shift

token - as Token till

states - as Collection of status type objects (Optional. If not specified will search across all Status)

Returns:

List of Tokens

getTokensFrom

List<T> getTokensFrom(S shift,
                      T token,
                      Collection states)

Get all Tokenss in sequence till (excluding) the token

Parameters:

shift - as Shift

token - as Token from (excluding)

states - as Collection of status type objects (Optional. If not specified will search across all Status)

Returns:

List of Tokens

getReadyToBeProcessed

List<T> getReadyToBeProcessed(S tokenContainer,
                              T lastToken)

Get tokens ready to be processed; from lastToken (excluding it)

Parameters:

tokenContainer - as container type

lastToken - as Token type , as last token the calling API received. This is optional. Since a Q is constantly @ risk of being modified this ensures error correction.

Returns:

List of Tokens

See Also:

QStatesStrategy

getPreProcess

List<T> getPreProcess(S tokenContainer)

Tokens that are not yet eligible to be in Q but are being considered.

Parameters:

tokenContainer - as container type

Returns:

List of Tokens

See Also:

QStatesStrategy

getInProcess

List<T> getInProcess(S tokenContainer)

Tokens that out of the Q but being processed

Parameters:

tokenContainer - as container type

Returns:

List of Tokens

See Also:

QStatesStrategy, #getProcessed(TokenContainer)

getProcessed

List<T> getProcessed(S tokenContainer)

Tokens that out of the Q and processed

Parameters:

tokenContainer - as container type

Returns:

List of Tokens

See Also:

QStatesStrategy, #getInProcess(TokenContainer)

reset

S reset(S shift)

Reset/ReStart a new Shift based on data from an existing one. The exact conceptual meaning of this is business defined hence implementation dependent.

Parameters:

shift - as Shift type <S>

Returns:

getTokens

List<T> getTokens(S shift)

Get all Token

Parameters:

shift -

Returns:

List of Tokens

getAssignedShift

S getAssignedShift(T token)

For a Token determine its assigned Shift.
This is also expected to update the token object with the Shift data retrieved, if the Shift data needs to be derived. The operation is mutable over token.getBatchInfo().setShift()
Note: This will not determine its Shift but only confirm its assigned shift

Parameters:

tokens -

Returns:

getAssignedContainer

default S getAssignedContainer(T token)

Description copied from interface: TokenContainerService

For a Token get the container

Specified by:

getAssignedContainer in interface TokenContainerService<T extends Token<T>,S extends Shift<T>>

Parameters:

token - as Token

Returns:

findInActiveShifts

List<S> findInActiveShifts(Object o,
                           Predicate<S> filter,
                           boolean activeTokensOnly)

For an object like user/consumer find the shifts they are in, across all Shifts of type <S>

Parameters:

object - as object we re finding

filter - as Predicate. If Predicate#test(Shift) is true then only will it include the shift for its search. @nullable true

activeTokensOnly - as boolean. If true will scan only active tokens or else will scan all tokens in the history.

Returns:

List of Shifts <S>. null if not in any Active Shift

findTokensInActiveShifts

List<T> findTokensInActiveShifts(Object o,
                                 Predicate<S> filter,
                                 boolean activeTokensOnly)

For an object like user/consumer find the tokens across all Shifts of type <S>

Parameters:

object - as object we re finding

filter - as Predicate. If Predicate#test(Shift) is true then only will it include the shift for its search. @nullable true

activeTokensOnly - as boolean. If true will scan only active tokens or else will scan all tokens in the history.

Returns:

List of Shifts <S>. null if not in any Active Shift

getDao

<DAO> DAO getDao()

Get any DAO backing this service

Returns: