Bookshelf Home | Contents | Index | Search | PDF |
Siebel Developer's Reference > Business Component Classes > CSSBCActivity Class >
CSSBCActivity Methods
This section describes the methods that are implemented in the CSSBCActivity Class.
BuildActivityArray
The BuildActivityArray method adds the appointments record from the SQL object, and generates a list of repeating appointment instances that have been overridden.
CalendarNewMode
The CalendarNewMode method specifies whether or not the business component is in Calendar New mode.
CleanEmployeeOnNewRecord
The CleanEmployeeOnNewRecord method triggers the business component to clear the logged-in User Id from the Owner MVG if the logged-in user is different from employee set on the current business component.
ClearAllowOverrides
The ClearAllowOverrides method turns off the ability for the user to override the search specification on the Activity List view.
ClearGridBeginEndDate
The ClearGridBeginEndDate method turns off the instantiated flag and clears the sort specification for the business component.
ClearModifyFlag
The ClearModifyFlag method turns off the repeating activity modification flag, which indicates that this is a nonrepeating activity.
CompleteActivity
The CompleteActivity method commits the current record, and passes the current Activity Id to the Complete Activity business service to complete current activity. Once complete, the business component updates the following business components:
This method can only be called in nonquery mode.
CreateCommActivity
The CreateCommActivity method triggers the business component to create a new activity record with the values specified in the arguments. The user will get an error report if one or more fields cannot be set, unless other errors are returned.
The arguments for CreateCommActivity comprise a Field Value Array.
CreateExceptionRecord
The CreateExceptionRecord method creates a new record as an exception of a repeating appointment.
CreateOverrideRecord
The CreateOverrideRecord method creates a new ghost record that overrides an instance of a repeating appointment.
DeleteAll
The DeleteAll method deletes the appointment if the user is the primary owner, or dissociates the user from the appointment if the user is not the primary owner.
For repeating and nonrepeating appointments, the DeleteAll method acts on the record.
DeleteInstance
The DeleteInstance method calls the DeleteThisOne method to delete an instance of the appointment if the user is the primary owner, or dissociates the user from an instance of the appointment if the user is not the primary owner.
For a repeating appointment, the DeleteInstance method acts on a single instance. For a nonrepeating appointment, the DeleteInstance method acts on the record.
DeleteThisOne
The DeleteThisOne method deletes an instance of the appointment if the user is the primary owner, or dissociates the user from an instance of the appointment if the user is not the primary owner. This method is called by DeleteInstance.
EmptyActivityArray
The EmptyActivityArray method clears the activity array for calendar.
GetLogin
The GetLogin method returns a string that consists of the logged-in user's name and ID. You can use string-to-array conversion to reference the values separately.
GetPrimaryPositionId
The GetPrimaryPositionId method returns a string that consists of the primary position id of the logged in user, and Y/N system preference value of Auto Calendar Manager Access for this position.
GetSqlExecutedFlag
The GetSqlExecutedFlag method returns a string value of TRUE/FALSE that indicates whether or not Execute will be skipped for this business component.
InitCalendar
The InitCalendar method initializes the calendar with the specified parameters.
IsCalendarMode
The IsCalendarMode method returns a Y/N value to indicate whether or not the application is in Calendar Mode. This method is used for wireless applications only.
IsInited
The IsInited method verifies whether or not the calendar is initialized. If initialized, this method returns a string value that consists of following values in sequence:
You can use string-to-array conversion to reference these values separately.
IsInitedLocale
The IsInitedLocale method behaves the same as the IsInited method. However, all values are returned as formatted string values according to current locale.
IsOnlyLoginUser
The IsOnlyLoginUser method returns a Y/N value to indicate whether or not the logged-in user is the only owner in the Owned By MVG business component, and that there are no records in Contact MVG.
IsOriginalRepActivityId
The IsOriginalRepActivityId method returns a Y/N value to indicate whether or not the specified Activity Id is the original repeating Activity Id. If the specified Activity is the original repeating Activity Id, the IsOriginalRepActivityId method returns Y; otherwise it returns N.
IsParticipantsChanged
The IsParticipantsChanged method returns a Y/N value to indicate whether or not new records have been added to either the Owned By MVG or the Contact MVG.
IsPrimaryInMVG
The IsPrimaryInMVG method returns a Y/N value to indicate whether or not the current employee ID is the primary in the MVG of the specified Field Name.
IsRecordRepActivity
The IsRecordRepActivity method returns a Y/N value to indicate whether or not the current activity record is a repeating activity.
IsRepActivityId
The IsRepActivityId method returns a string value of the Repeating Id of a specified Activity Id, and a Y/N value indicating whether or not the specified Activity Id is a repeating activity. You can use string-to-array conversion to reference the returned values separately.
PositionToNewRecFromAux
The PositionToNewRecFromAux method moves the position to the repeat activity record that was created using the SqlWriteRecord method. This method is used for wireless applications only.
RefreshFields
The RefreshFields method calls the notifynewdata method for each field name specified.
RemLoginOnNewRecord
The RemLoginOnNewRecord method removes the logged-in user's ID from the Owned By MVG.
RemoveFromAuxTeam
The RemoveFromAuxTeam method removes the employees listed in the arguments from Action Employee, where the employee's Activity Id matches the current Activity Id.
If no Employee Id is specified, this method uses the employee that has been set on the current business component.
RemoveFromTeam
The RemoveFromTeam method removes the employees listed in the arguments from Action Employee, where the employee's Activity Id matches the current Activity Id.
If no Employee Id is specified, this method uses the employee that has been set on the current business component.
ResetInited
The ResetInited method resets the calendar initialization flag to FALSE.
SaveThisOne
The SaveThisOne method creates an exception record and an override record for a repeating appointment.
SaveWebCollabData
The SaveWebCollabData method saves Web collaboration chat script and other data.
The arguments for SaveWebCollabData comprise a list of chat script and other data.
SetActivityContact
The SetActivityContact method adds a Contact record for CSSBCBase. It can be either a multivalue field (MVF) on an intersection table plus a single-value field (SVF) on the action Primary Contact Id, or just a SVF on the Action business component.
SetAlarmFilter
The SetAlarmFilter method turns the Alarm Filter on or off.
SetAllowOverrides
The SetAllowOverrides method allows the ability for the user to override the search specification on the Activity List view.
SetAvailCalUpdateIds
The SetAvailCalUpdateIds method saves the User Id of each user whose calendar the current user can update.
SetCommTypes
The SetCommTypes method sets the communication type.
SetCurrentViewDate
The SetCurrentViewDate method sets the current view date for calendar.
SetEmployeeId
The SetEmployeeId method sets the Employee Login Id and Employee Login Name for the current Activity business component.
SetEmployeeList
The SetEmployeeList method sets Employee Ids for the current business component to support multiple employees. The arguments for SetEmployeeList consist of Employee Ids for each employee to put in the list.
SetGridBeginEndDate
The SetGridBeginEndDate method sets the Begin Date and End Date for the grid.
SetModifyFlag
The SetModifyFlag method sets the repeating activity modification flag.
SetSkipSqlExecuteFlag
The SetSkipSqlExecuteFlag method sets a flag to prevent execution of the business component.
Bookshelf Home | Contents | Index | Search | PDF |
Siebel Developer's Reference Published: 23 October 2003 |