Package com.redwood.scheduler.api.model
Interface SAPCalendar
- 
- All Superinterfaces:
- BusinessKeyObject,- Detail,- Readable,- SchedulerEntity,- SchedulerEntityComp
 
 public interface SAPCalendar extends Detail, BusinessKeyObject, Readable SAP calendars.
- 
- 
Field SummaryFields Modifier and Type Field Description static StringOBJECT_TYPEString that will be returned fromSchedulerEntity.getObjectType()for "SAPCalendar" objects.static StringSEC_RANK_ALLThis rank is made of the following privileges:static StringSEC_RANK_NONEThis rank has no privileges assigned to it.static QueryObjectType<SAPCalendar>TYPEType that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).- 
Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntityACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDescription()Get the value for Description.StringgetIdent()Get the value for Ident.StringgetMonth1()Get the value for Month1.StringgetMonth10()Get the value for Month10.StringgetMonth11()Get the value for Month11.StringgetMonth12()Get the value for Month12.StringgetMonth2()Get the value for Month2.StringgetMonth3()Get the value for Month3.StringgetMonth4()Get the value for Month4.StringgetMonth5()Get the value for Month5.StringgetMonth6()Get the value for Month6.StringgetMonth7()Get the value for Month7.StringgetMonth8()Get the value for Month8.StringgetMonth9()Get the value for Month9.SAPSystemgetSAPSystem()Get the SAPSystem.StringgetType()Get the value for Type.LonggetYear()Get the value for Year.voidsetDescription(String newDescription)Set the value for Description.voidsetIdent(String newIdent)Set the value for Ident.voidsetMonth1(String newMonth1)Set the value for Month1.voidsetMonth10(String newMonth10)Set the value for Month10.voidsetMonth11(String newMonth11)Set the value for Month11.voidsetMonth12(String newMonth12)Set the value for Month12.voidsetMonth2(String newMonth2)Set the value for Month2.voidsetMonth3(String newMonth3)Set the value for Month3.voidsetMonth4(String newMonth4)Set the value for Month4.voidsetMonth5(String newMonth5)Set the value for Month5.voidsetMonth6(String newMonth6)Set the value for Month6.voidsetMonth7(String newMonth7)Set the value for Month7.voidsetMonth8(String newMonth8)Set the value for Month8.voidsetMonth9(String newMonth9)Set the value for Month9.voidsetType(String newType)Set the value for Type.voidsetYear(Long newYear)Set the value for Year.- 
Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObjectgetBusinessKey
 - 
Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntitycanPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead
 
- 
 
- 
- 
- 
Field Detail- 
OBJECT_TYPEstatic final String OBJECT_TYPE String that will be returned fromSchedulerEntity.getObjectType()for "SAPCalendar" objects.- See Also:
- Constant Field Values
 
 - 
TYPEstatic final QueryObjectType<SAPCalendar> TYPE Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
 - 
SEC_RANK_NONEstatic final String SEC_RANK_NONE This rank has no privileges assigned to it.- See Also:
- Constant Field Values
 
 - 
SEC_RANK_ALLstatic final String SEC_RANK_ALL This rank is made of the following privileges:- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getDescriptionString getDescription() Get the value for Description. (The description of this calendar)- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getTypeString getType() Get the value for Type. (Calendar type) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getYearLong getYear() Get the value for Year. (Calendar year) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getIdentString getIdent() Get the value for Ident. (Calendar name) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth1String getMonth1() Get the value for Month1. (Month 1 (January)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth2String getMonth2() Get the value for Month2. (Month 2 (February)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth3String getMonth3() Get the value for Month3. (Month 3 (March)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth4String getMonth4() Get the value for Month4. (Month 4 (April)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth5String getMonth5() Get the value for Month5. (Month 5 (May)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth6String getMonth6() Get the value for Month6. (Month 6 (June)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth7String getMonth7() Get the value for Month7. (Month 7 (July)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth8String getMonth8() Get the value for Month8. (Month 8 (August)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth9String getMonth9() Get the value for Month9. (Month 9 (September)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth10String getMonth10() Get the value for Month10. (Month 10 (October)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth11String getMonth11() Get the value for Month11. (Month 11 (November)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getMonth12String getMonth12() Get the value for Month12. (Month 12 (December)) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setDescriptionvoid setDescription(String newDescription) Set the value for Description. (The description of this calendar) This value is optional.- Parameters:
- newDescription- the new value for Description.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setTypevoid setType(String newType) Set the value for Type. (Calendar type) This value is mandatory.- Parameters:
- newType- the new value for Type. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setYearvoid setYear(Long newYear) Set the value for Year. (Calendar year) This value is mandatory.- Parameters:
- newYear- the new value for Year. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setIdentvoid setIdent(String newIdent) Set the value for Ident. (Calendar name) This value is mandatory.- Parameters:
- newIdent- the new value for Ident. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth1void setMonth1(String newMonth1) Set the value for Month1. (Month 1 (January)) This value is mandatory.- Parameters:
- newMonth1- the new value for Month1. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth2void setMonth2(String newMonth2) Set the value for Month2. (Month 2 (February)) This value is mandatory.- Parameters:
- newMonth2- the new value for Month2. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth3void setMonth3(String newMonth3) Set the value for Month3. (Month 3 (March)) This value is mandatory.- Parameters:
- newMonth3- the new value for Month3. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth4void setMonth4(String newMonth4) Set the value for Month4. (Month 4 (April)) This value is mandatory.- Parameters:
- newMonth4- the new value for Month4. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth5void setMonth5(String newMonth5) Set the value for Month5. (Month 5 (May)) This value is mandatory.- Parameters:
- newMonth5- the new value for Month5. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth6void setMonth6(String newMonth6) Set the value for Month6. (Month 6 (June)) This value is mandatory.- Parameters:
- newMonth6- the new value for Month6. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth7void setMonth7(String newMonth7) Set the value for Month7. (Month 7 (July)) This value is mandatory.- Parameters:
- newMonth7- the new value for Month7. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth8void setMonth8(String newMonth8) Set the value for Month8. (Month 8 (August)) This value is mandatory.- Parameters:
- newMonth8- the new value for Month8. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth9void setMonth9(String newMonth9) Set the value for Month9. (Month 9 (September)) This value is mandatory.- Parameters:
- newMonth9- the new value for Month9. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth10void setMonth10(String newMonth10) Set the value for Month10. (Month 10 (October)) This value is mandatory.- Parameters:
- newMonth10- the new value for Month10. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth11void setMonth11(String newMonth11) Set the value for Month11. (Month 11 (November)) This value is mandatory.- Parameters:
- newMonth11- the new value for Month11. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
setMonth12void setMonth12(String newMonth12) Set the value for Month12. (Month 12 (December)) This value is mandatory.- Parameters:
- newMonth12- the new value for Month12. If this is- null, then the object cannot be persisted.
- Throws:
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
 
 - 
getSAPSystemSAPSystem getSAPSystem() Get the SAPSystem.- Returns:
- SAPSystem
- Throws:
- com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.
- com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
 
 
- 
 
-