com.sas.hls.schedule
Class ScheduleDescriptor

java.lang.Object
  extended by com.sas.hls.common.AbstractIdentifiable
      extended by com.sas.hls.schedule.ScheduleDescriptor
All Implemented Interfaces:
Identifiable, Serializable
Direct Known Subclasses:
Schedule

public class ScheduleDescriptor
extends AbstractIdentifiable

A light-weight client representation of a schedule. See Schedule for details.

See Also:
Serialized Form

Nested Class Summary
static class ScheduleDescriptor.ScheduleStatus
          ScheduleStatus is an enum status of a schedule.
 
Field Summary
static String OBJECT_TYPE
          Represents the type name of a Schedule object.
 
Constructor Summary
ScheduleDescriptor()
          Default constructor
ScheduleDescriptor(String scheduleKeyName, String scheduleGroupName)
          Constructor used by the api to populate key values used by the server
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getDescription()
          Return the description of this schedule.
 Date getLastModifiedDate()
          Return the date this schedule was last modified.
 String getName()
          Return the name of this schedule.
 String getOwner()
          Return the owner of this schedule.
 String getSchedulableLabel()
          Return the label of this schedule.
 String getScheduleKeyGroupName()
          Return the schedule key group name.
 String getScheduleKeyName()
          Return the key name for this schedule.
 ScheduleDescriptor.ScheduleStatus getStatus()
          Return the schedule's status.
 void setDescription(String description)
          Set the description of this schedule.
 void setLastModifiedDate(Date lastModifiedDate)
          Set the date this schedule was last modified.
 void setName(String name)
          Set the name of this schedule.
 void setOwner(String owner)
          Set the opwner of this schedule.
 void setSchedulableLabel(String schedulableLabel)
          Set the label of this schedule.
 void setStatus(ScheduleDescriptor.ScheduleStatus status)
          Set the schedule's status.
 
Methods inherited from class com.sas.hls.common.AbstractIdentifiable
getIdentifier, getObjectType, hashCode, setIdentifier, setObjectType
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_TYPE

public static final String OBJECT_TYPE
Represents the type name of a Schedule object.

See Also:
Constant Field Values
Constructor Detail

ScheduleDescriptor

public ScheduleDescriptor()
Default constructor


ScheduleDescriptor

public ScheduleDescriptor(String scheduleKeyName,
                          String scheduleGroupName)
Constructor used by the api to populate key values used by the server

Parameters:
scheduleKeyName - The schedule key name used by the server
scheduleGroupName - he schedule key name used by the server
Method Detail

getStatus

public ScheduleDescriptor.ScheduleStatus getStatus()
Return the schedule's status.

Returns:
Returns the status.

setStatus

public void setStatus(ScheduleDescriptor.ScheduleStatus status)
Set the schedule's status.

Parameters:
status - The status to set.

getName

public String getName()
Return the name of this schedule.

Returns:
Returns the name.

setName

public void setName(String name)
Set the name of this schedule.

Parameters:
name - The name to set.

getDescription

public String getDescription()
Return the description of this schedule.

Returns:
Returns the description.

setDescription

public void setDescription(String description)
Set the description of this schedule.

Parameters:
description - The description to set.

getOwner

public String getOwner()
Return the owner of this schedule.

Returns:
Returns the owner.

setOwner

public void setOwner(String owner)
Set the opwner of this schedule.

Parameters:
owner - The owner to set.

getLastModifiedDate

public Date getLastModifiedDate()
Return the date this schedule was last modified.

Returns:
Returns the date this schedule was last modified.

setLastModifiedDate

public void setLastModifiedDate(Date lastModifiedDate)
Set the date this schedule was last modified.

Parameters:
lastModifiedDate - The date this schedule was last modified.

getSchedulableLabel

public String getSchedulableLabel()
Return the label of this schedule.

Returns:
Returns the label of the item you are scheduling.

setSchedulableLabel

public void setSchedulableLabel(String schedulableLabel)
Set the label of this schedule.

Parameters:
schedulableLabel - Label of the item you are scheduling.

getScheduleKeyName

public String getScheduleKeyName()
Return the key name for this schedule.

Returns:
Returns the schedule key name.

getScheduleKeyGroupName

public String getScheduleKeyGroupName()
Return the schedule key group name.

Returns:
Returns the schedule key group name.

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class AbstractIdentifiable
See Also:
Object.equals(java.lang.Object)


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA