com.solidfire.adaptor

Class ScheduleAdaptor

java.lang.Object

com.solidfire.adaptor.ScheduleAdaptor

public class ScheduleAdaptor
extends java.lang.Object

Created by Jason Ryan Womack on 8/11/16.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DAYS_OF_MONTH
static java.lang.String	DAYS_OF_WEEK
static java.lang.String	FREQUENCY
static java.lang.String	TIME_INTERVAL

Constructor Summary

Constructors

Constructor and Description
ScheduleAdaptor()

Method Summary

Modifier and Type	Method and Description
static CreateScheduleResult	createSchedule(SolidFireElement sfe, CreateScheduleRequest request) This adaptor modifies the Simple Schedule object, which uses the Frequency classes that delineate different types of scheduling frequencies, into an ApiSchedule object.
static GetScheduleResult	getSchedule(SolidFireElement sfe, GetScheduleRequest request) This adaptor modifies the ApiSchedule object returned by the GetSchedule API call into a Simple Schedule object using the Frequency classes that delineate different types of scheduling frequencies.
static ListSchedulesResult	listSchedules(SolidFireElement sfe) This adaptor modifies the ApiSchedule object returned by the ListSchedules API call into a Simple Schedule object using the Frequency classes that delineate different types of scheduling frequencies.
static ModifyScheduleResult	modifySchedule(SolidFireElement sfe, ModifyScheduleRequest request) This adaptor modifies the Simple Schedule object, which uses the Frequency classes that delineate different types of scheduling frequencies, into an ApiSchedule object.
static ApiSchedule	toApiSchedule(Schedule schedule) Converts a Schedule object into an ApiSchedule object
static Schedule	toSchedule(ApiSchedule api) Converts an ApiSchedule object into a Schedule object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIME_INTERVAL

public static final java.lang.String TIME_INTERVAL

See Also:

Constant Field Values

DAYS_OF_MONTH

public static final java.lang.String DAYS_OF_MONTH

See Also:

Constant Field Values

DAYS_OF_WEEK

public static final java.lang.String DAYS_OF_WEEK

See Also:

Constant Field Values

FREQUENCY

public static final java.lang.String FREQUENCY

See Also:

Constant Field Values

Constructor Detail

ScheduleAdaptor

public ScheduleAdaptor()

Method Detail

getSchedule

public static GetScheduleResult getSchedule(SolidFireElement sfe,
                                            GetScheduleRequest request)

This adaptor modifies the ApiSchedule object returned by the GetSchedule API call into a Simple Schedule object using the Frequency classes that delineate different types of scheduling frequencies.

Parameters:

sfe - An instance of SolidFireElement

request - The original request object.

Returns:

a GetScheduleResult with the modified simple schedule object

See Also:

Frequency

listSchedules

public static ListSchedulesResult listSchedules(SolidFireElement sfe)

This adaptor modifies the ApiSchedule object returned by the ListSchedules API call into a Simple Schedule object using the Frequency classes that delineate different types of scheduling frequencies.

Parameters:

sfe - An instance of SolidFireElement

Returns:

a ListScheduleResult with the modified simple schedule objects

createSchedule

public static CreateScheduleResult createSchedule(SolidFireElement sfe,
                                                  CreateScheduleRequest request)

This adaptor modifies the Simple Schedule object, which uses the Frequency classes that delineate different types of scheduling frequencies, into an ApiSchedule object. This API object is passed into the CreateSchedule API call.

Parameters:

sfe - An instance of SolidFireElement

request - The original request object.

Returns:

a CreateScheduleResult

modifySchedule

public static ModifyScheduleResult modifySchedule(SolidFireElement sfe,
                                                  ModifyScheduleRequest request)

This adaptor modifies the Simple Schedule object, which uses the Frequency classes that delineate different types of scheduling frequencies, into an ApiSchedule object. This API object is passed into the CreateSchedule API call. The result of the API call is then transformed back into a Simple Schedule object.

Parameters:

sfe - An instance of SolidFireElement

request - The original request object.

Returns:

a ModifyScheduleResult with the modified simple schedule objects

toSchedule

public static Schedule toSchedule(ApiSchedule api)

Converts an ApiSchedule object into a Schedule object

Parameters:

api - the ApiSchedule object to be converted

Returns:

a Schedule object

toApiSchedule

public static ApiSchedule toApiSchedule(Schedule schedule)

Converts a Schedule object into an ApiSchedule object

Parameters:

schedule - the Schedule object to be converted

Returns:

an ApiSchedule object