C# Class ATUL_v1.AtulRest

Inheritance: IAtulRest
Show file Open project: godaddy/ATUL

Public Methods

Method Description
AddActivityToActivityGroup ( int AtulActivityGroupID, int AtulActivityID, int CreatedBy ) : bool

Adds the activity to activity group.

AddActivityToActivityGroup ( string AtulActivityGroupID, string AtulActivityID, string CreatedBy ) : bool

Adds the activity to activity group.

AddProcessManager ( int AtulRemoteSystemID, int AtulUserTypeID, string RemoteSystemLoginID, string DisplayName ) : bool

Adds a process manager. A process can have more than one manager. This method is intended to create a manager, but is generic since the typeId will change The typeid should be set in the webconfig and retreived in the logic layer

AddProcessManager ( string AtulRemoteSystemID, string AtulUserTypeID, string RemoteSystemLoginID, string DisplayName ) : bool

Adds a process manager. A process can have more than one manager. This method is intended to create a manager, but is generic since the typeId will change The typeid should be set in the webconfig and retreived in the logic layer

CreateActivity ( string AtulSubProcessID, string ActivityDescription, string ActivitySummary, string ActivityProcedure, string AtulActivitySortOrder, string CreatedBy, string OwnedBy ) : bool

Creates the activity.

CreateActivity ( string processID, string subProcessID, string ActivityDescription, string ActivitySummary, string ActivityProcedure, bool deadlineResultsInMissed, int AtulActivitySortOrder, int CreatedBy, int OwnedBy, int deadline, int deadlineTypeID ) : long

Creates the activity.

CreateActivityGroup ( int AtulActivityGroupPurposeID, string ActivityGroupDescription, string ActivityGroupSummary, int CreatedBy ) : bool

Creates the activity group.

CreateActivityGroup ( string AtulActivityGroupPurposeID, string ActivityGroupDescription, string ActivityGroupSummary, string CreatedBy ) : bool

Creates the activity group.

CreateInstanceProcess ( int AtulProcessID, int CreatedBy, int OwnedBy, int AtulProcessStatusID ) : bool

Creates the instance process.

CreateInstanceProcess ( string AtulProcessID, string CreatedBy, string OwnedBy, string AtulProcessStatusID ) : bool

Creates the instance process.

CreateProcess ( string ProcessDescription, string ProcessSummary, int CreatedBy, int OwnedBy, int AtulProcessStatusID, int DeadLineOffset ) : long

Creates the process.

CreateProcess ( string ProcessDescription, string ProcessSummary, string CreatedBy, string OwnedBy, string AtulProcessStatusID, string DeadLineOffset ) : long

Creates the process.

CreateSubProcess ( int AtulProcessID, int AtulSubProcessID, int ProcessSubprocessSortOrder, int NotificationServiceProvideID, string NotificationIdentifier, int ResponsibilityOf, int DeadlineOffset, int CreatedBy ) : bool

Creates the sub process.

CreateSubProcess ( string AtulProcessID, string AtulSubProcessID, string ProcessSubprocessSortOrder, string NotificationServiceProvideID, string NotificationIdentifier, string ResponsibilityOf, string DeadlineOffset, string CreatedBy ) : bool

Creates the sub process.

DeleteActivity ( int AtulProcessID, int ModifiedBy ) : bool

Deletes the activity.

DeleteActivity ( string AtulProcessID, string ModifiedBy ) : bool

Deletes the activity.

DeleteActivityGroup ( int AtulActivityGroupID, int ModifiedBy ) : bool

Deletes the activity group.

DeleteActivityGroup ( string AtulActivityGroupID, string ModifiedBy ) : bool

Deletes the activity group.

DeleteInstanceProcess ( int AtulInstanceProcessID, int ModifiedBy ) : bool

Deletes the instance process.

DeleteInstanceProcess ( string AtulInstanceProcessID, string ModifiedBy ) : bool

Deletes the instance process.

DeleteInstanceProcessActivity ( int AtulSubProcessID, int ModifiedBy ) : bool

Deletes the instance process activity.

DeleteInstanceProcessActivity ( string AtulSubProcessID, string ModifiedBy ) : bool

Deletes the instance process activity.

DeleteProcess ( int AtulProcessID, int ModifiedBy ) : bool

Deletes the process.

DeleteProcess ( string AtulProcessID, string ModifiedBy ) : bool

Deletes the process.

DeleteProcessManager ( int AtulUserID ) : bool

Deletes the process manager. TODO: [This is invalid, we would need to specify the process, usertypeID and the userID. Probably need a new proc]

DeleteProcessManager ( string AtulUserID ) : bool

Deletes the process manager. TODO: [This is invalid, we would need to specify the process, usertypeID and the userID. Probably need a new proc]

DeleteSubProcess ( int AtulSubProcessID, int ModifiedBy ) : bool

Deletes the sub process.

DeleteSubProcess ( string AtulSubProcessID, string ModifiedBy ) : bool

Deletes the sub process.

EnableActivityAutomation ( ) : string

Enables the activity automation. TODO: Find/Define appliciable attribute

GetAllActivity ( ) : string

Gets all activity.

GetAllInstanceProcess ( ) : string

Gets all instance process.

GetAllInstanceProcessActivity ( ) : string

Gets all instance process activity.

GetAllProcess ( ) : string

Gets all process.

GetAllProcessActivityGroups ( ) : string

Gets all process activity groups.

GetAllProcessSubProcess ( ) : string

Gets all process sub process.

GetAllProcessSubProcessActivity ( ) : string

Gets all process sub process activity. TODO: New proc needed to get a subprocess's activities

GetInstanceProcessByID ( System.Int64 AtulInstanceProcessID ) : string

Gets the instance process by ID.

GetInstanceProcessByID ( string AtulInstanceProcessID ) : string

Gets the instance process by ID.

HelloWorldBool ( ) : bool

Helloes the world bool.

HelloWorldString ( string word ) : string

Helloes the world string.

InsertInstanceProcess ( int AtulProcessID, int CreatedBy, int OwnedBy, int AtulProcessStatusID ) : string

Inserts the instance process.

InsertInstanceProcess ( string AtulProcessID, string CreatedBy, string OwnedBy, string AtulProcessStatusID ) : string

Inserts the instance process.

InsertInstanceProcessActivity ( int AtulInstanceProcessID, int AtulProcessActivityID, int InstanceProcessActivityCompletedBy, int CreatedBy ) : string

Inserts the instance process activity.

InsertInstanceProcessActivity ( string AtulInstanceProcessID, string AtulProcessActivityID, string InstanceProcessActivityCompletedBy, string CreatedBy ) : string

Inserts the instance process activity.

SetActivityDeadLine ( ) : string

Sets the activity dead line.

SetActivityManMinutes ( ) : string

Sets the activity man minutes. TODO: Add man minute column, update proc(s)

SetActivityPrerequsiteActivityGroup ( ) : string

Sets the activity prerequsite activity group. TODO: Request proc to set prereq group Params: ActivityID, GroupID

UpdateInstanceProcess ( int AtulInstanceProcessID, int AtulProcessID, int ModifiedBy, int OwnedBy, int AtulProcessStatusID ) : string

Updates the instance process.

UpdateInstanceProcess ( string AtulInstanceProcessID, string AtulProcessID, string ModifiedBy, string OwnedBy, string AtulProcessStatusID ) : string

Updates the instance process.

UpdateInstanceProcessActivity ( int AtulInstanceProcessActivityID, int AtulInstanceProcessID, int AtulProcessActivityID, int ProcessActivityCompleted, int ProcessActivityDidNotApply, int ProcessActivityDeadlineMissed, int InstanceProcessActivityCompletedBy, int ModifiedBy ) : string

Updates the instance process activity.

UpdateInstanceProcessActivity ( string AtulInstanceProcessActivityID, string AtulInstanceProcessID, string AtulProcessActivityID, string ProcessActivityCompleted, string ProcessActivityDidNotApply, string ProcessActivityDeadlineMissed, string InstanceProcessActivityCompletedBy, string ModifiedBy ) : string

Updates the instance process activity.

UpdateRunningProcessSpecification ( ) : string

Updates the running process specification. TODO: MAtch to docs, discuss with Cory

Method Details

AddActivityToActivityGroup() public method

Adds the activity to activity group.
public AddActivityToActivityGroup ( int AtulActivityGroupID, int AtulActivityID, int CreatedBy ) : bool
AtulActivityGroupID int The atul activity group ID.
AtulActivityID int The atul activity ID.
CreatedBy int The created by ID.
return bool

AddActivityToActivityGroup() public method

Adds the activity to activity group.
public AddActivityToActivityGroup ( string AtulActivityGroupID, string AtulActivityID, string CreatedBy ) : bool
AtulActivityGroupID string The atul activity group ID.
AtulActivityID string The atul activity ID.
CreatedBy string The created by ID.
return bool

AddProcessManager() public method

Adds a process manager. A process can have more than one manager. This method is intended to create a manager, but is generic since the typeId will change The typeid should be set in the webconfig and retreived in the logic layer
public AddProcessManager ( int AtulRemoteSystemID, int AtulUserTypeID, string RemoteSystemLoginID, string DisplayName ) : bool
AtulRemoteSystemID int The atul remote system ID.
AtulUserTypeID int The atul user type ID.
RemoteSystemLoginID string The remote system login ID.
DisplayName string The display name.
return bool

AddProcessManager() public method

Adds a process manager. A process can have more than one manager. This method is intended to create a manager, but is generic since the typeId will change The typeid should be set in the webconfig and retreived in the logic layer
public AddProcessManager ( string AtulRemoteSystemID, string AtulUserTypeID, string RemoteSystemLoginID, string DisplayName ) : bool
AtulRemoteSystemID string The atul remote system ID.
AtulUserTypeID string The atul user type ID.
RemoteSystemLoginID string The remote system login ID.
DisplayName string The display name.
return bool

CreateActivity() public method

Creates the activity.
public CreateActivity ( string AtulSubProcessID, string ActivityDescription, string ActivitySummary, string ActivityProcedure, string AtulActivitySortOrder, string CreatedBy, string OwnedBy ) : bool
AtulSubProcessID string The atul sub process ID.
ActivityDescription string The activity description.
ActivitySummary string The activity summary.
ActivityProcedure string The activity procedure.
AtulActivitySortOrder string The atul activity sort order.
CreatedBy string The created by ID.
OwnedBy string The owned by ID.
return bool

CreateActivity() public method

Creates the activity.
public CreateActivity ( string processID, string subProcessID, string ActivityDescription, string ActivitySummary, string ActivityProcedure, bool deadlineResultsInMissed, int AtulActivitySortOrder, int CreatedBy, int OwnedBy, int deadline, int deadlineTypeID ) : long
processID string
subProcessID string
ActivityDescription string The activity description.
ActivitySummary string The activity summary.
ActivityProcedure string The activity procedure.
deadlineResultsInMissed bool
AtulActivitySortOrder int The atul activity sort order.
CreatedBy int The created by ID.
OwnedBy int The owned by ID.
deadline int
deadlineTypeID int
return long

CreateActivityGroup() public method

Creates the activity group.
public CreateActivityGroup ( int AtulActivityGroupPurposeID, string ActivityGroupDescription, string ActivityGroupSummary, int CreatedBy ) : bool
AtulActivityGroupPurposeID int The atul activity group purpose ID.
ActivityGroupDescription string The activity group description.
ActivityGroupSummary string The activity group summary.
CreatedBy int The created by ID.
return bool

CreateActivityGroup() public method

Creates the activity group.
public CreateActivityGroup ( string AtulActivityGroupPurposeID, string ActivityGroupDescription, string ActivityGroupSummary, string CreatedBy ) : bool
AtulActivityGroupPurposeID string The atul activity group purpose ID.
ActivityGroupDescription string The activity group description.
ActivityGroupSummary string The activity group summary.
CreatedBy string The created by ID.
return bool

CreateInstanceProcess() public method

Creates the instance process.
public CreateInstanceProcess ( int AtulProcessID, int CreatedBy, int OwnedBy, int AtulProcessStatusID ) : bool
AtulProcessID int The atul process ID.
CreatedBy int The created by ID.
OwnedBy int The owned by ID.
AtulProcessStatusID int The atul process status ID.
return bool

CreateInstanceProcess() public method

Creates the instance process.
public CreateInstanceProcess ( string AtulProcessID, string CreatedBy, string OwnedBy, string AtulProcessStatusID ) : bool
AtulProcessID string The atul process ID.
CreatedBy string The created by ID.
OwnedBy string The owned by ID.
AtulProcessStatusID string The atul process status ID.
return bool

CreateProcess() public method

Creates the process.
public CreateProcess ( string ProcessDescription, string ProcessSummary, int CreatedBy, int OwnedBy, int AtulProcessStatusID, int DeadLineOffset ) : long
ProcessDescription string The process description.
ProcessSummary string The process summary.
CreatedBy int The created by.
OwnedBy int The owned by.
AtulProcessStatusID int The atul process status ID.
DeadLineOffset int The dead line offset.
return long

CreateProcess() public method

Creates the process.
public CreateProcess ( string ProcessDescription, string ProcessSummary, string CreatedBy, string OwnedBy, string AtulProcessStatusID, string DeadLineOffset ) : long
ProcessDescription string The process description.
ProcessSummary string The process summary.
CreatedBy string The created by.
OwnedBy string The owned by.
AtulProcessStatusID string The atul process status ID.
DeadLineOffset string The dead line offset.
return long

CreateSubProcess() public method

Creates the sub process.
public CreateSubProcess ( int AtulProcessID, int AtulSubProcessID, int ProcessSubprocessSortOrder, int NotificationServiceProvideID, string NotificationIdentifier, int ResponsibilityOf, int DeadlineOffset, int CreatedBy ) : bool
AtulProcessID int The atul process ID.
AtulSubProcessID int The atul sub process ID.
ProcessSubprocessSortOrder int The process subprocess sort order.
NotificationServiceProvideID int The notification service provide ID.
NotificationIdentifier string The notification identifier.
ResponsibilityOf int The responsibility of ID.
DeadlineOffset int The deadline offset.
CreatedBy int The created by ID.
return bool

CreateSubProcess() public method

Creates the sub process.
public CreateSubProcess ( string AtulProcessID, string AtulSubProcessID, string ProcessSubprocessSortOrder, string NotificationServiceProvideID, string NotificationIdentifier, string ResponsibilityOf, string DeadlineOffset, string CreatedBy ) : bool
AtulProcessID string The atul process ID.
AtulSubProcessID string The atul sub process ID.
ProcessSubprocessSortOrder string The process subprocess sort order.
NotificationServiceProvideID string The notification service provide ID.
NotificationIdentifier string The notification identifier.
ResponsibilityOf string The responsibility of ID.
DeadlineOffset string The deadline offset.
CreatedBy string The created by ID.
return bool

DeleteActivity() public method

Deletes the activity.
public DeleteActivity ( int AtulProcessID, int ModifiedBy ) : bool
AtulProcessID int The atul process ID.
ModifiedBy int The modified by.
return bool

DeleteActivity() public method

Deletes the activity.
public DeleteActivity ( string AtulProcessID, string ModifiedBy ) : bool
AtulProcessID string The atul process ID.
ModifiedBy string
return bool

DeleteActivityGroup() public method

Deletes the activity group.
public DeleteActivityGroup ( int AtulActivityGroupID, int ModifiedBy ) : bool
AtulActivityGroupID int The atul activity group ID.
ModifiedBy int The modified by.
return bool

DeleteActivityGroup() public method

Deletes the activity group.
public DeleteActivityGroup ( string AtulActivityGroupID, string ModifiedBy ) : bool
AtulActivityGroupID string The atul activity group ID.
ModifiedBy string The modified by.
return bool

DeleteInstanceProcess() public method

Deletes the instance process.
public DeleteInstanceProcess ( int AtulInstanceProcessID, int ModifiedBy ) : bool
AtulInstanceProcessID int
ModifiedBy int
return bool

DeleteInstanceProcess() public method

Deletes the instance process.
public DeleteInstanceProcess ( string AtulInstanceProcessID, string ModifiedBy ) : bool
AtulInstanceProcessID string
ModifiedBy string
return bool

DeleteInstanceProcessActivity() public method

Deletes the instance process activity.
public DeleteInstanceProcessActivity ( int AtulSubProcessID, int ModifiedBy ) : bool
AtulSubProcessID int
ModifiedBy int
return bool

DeleteInstanceProcessActivity() public method

Deletes the instance process activity.
public DeleteInstanceProcessActivity ( string AtulSubProcessID, string ModifiedBy ) : bool
AtulSubProcessID string
ModifiedBy string
return bool

DeleteProcess() public method

Deletes the process.
public DeleteProcess ( int AtulProcessID, int ModifiedBy ) : bool
AtulProcessID int The atul process ID.
ModifiedBy int The modified by.
return bool

DeleteProcess() public method

Deletes the process.
public DeleteProcess ( string AtulProcessID, string ModifiedBy ) : bool
AtulProcessID string The atul process ID.
ModifiedBy string The modified by.
return bool

DeleteProcessManager() public method

Deletes the process manager. TODO: [This is invalid, we would need to specify the process, usertypeID and the userID. Probably need a new proc]
public DeleteProcessManager ( int AtulUserID ) : bool
AtulUserID int The atul user ID.
return bool

DeleteProcessManager() public method

Deletes the process manager. TODO: [This is invalid, we would need to specify the process, usertypeID and the userID. Probably need a new proc]
public DeleteProcessManager ( string AtulUserID ) : bool
AtulUserID string The atul user ID.
return bool

DeleteSubProcess() public method

Deletes the sub process.
public DeleteSubProcess ( int AtulSubProcessID, int ModifiedBy ) : bool
AtulSubProcessID int The atul sub process ID.
ModifiedBy int The modified by.
return bool

DeleteSubProcess() public method

Deletes the sub process.
public DeleteSubProcess ( string AtulSubProcessID, string ModifiedBy ) : bool
AtulSubProcessID string The atul sub process ID.
ModifiedBy string The modified by.
return bool

EnableActivityAutomation() public method

Enables the activity automation. TODO: Find/Define appliciable attribute
public EnableActivityAutomation ( ) : string
return string

GetAllActivity() public method

Gets all activity.
public GetAllActivity ( ) : string
return string

GetAllInstanceProcess() public method

Gets all instance process.
public GetAllInstanceProcess ( ) : string
return string

GetAllInstanceProcessActivity() public method

Gets all instance process activity.
public GetAllInstanceProcessActivity ( ) : string
return string

GetAllProcess() public method

Gets all process.
public GetAllProcess ( ) : string
return string

GetAllProcessActivityGroups() public method

Gets all process activity groups.
public GetAllProcessActivityGroups ( ) : string
return string

GetAllProcessSubProcess() public method

Gets all process sub process.
public GetAllProcessSubProcess ( ) : string
return string

GetAllProcessSubProcessActivity() public method

Gets all process sub process activity. TODO: New proc needed to get a subprocess's activities
public GetAllProcessSubProcessActivity ( ) : string
return string

GetInstanceProcessByID() public method

Gets the instance process by ID.
public GetInstanceProcessByID ( System.Int64 AtulInstanceProcessID ) : string
AtulInstanceProcessID System.Int64 The atul instance process ID.
return string

GetInstanceProcessByID() public method

Gets the instance process by ID.
public GetInstanceProcessByID ( string AtulInstanceProcessID ) : string
AtulInstanceProcessID string The atul instance process ID.
return string

HelloWorldBool() public method

Helloes the world bool.
public HelloWorldBool ( ) : bool
return bool

HelloWorldString() public method

Helloes the world string.
public HelloWorldString ( string word ) : string
word string
return string

InsertInstanceProcess() public method

Inserts the instance process.
public InsertInstanceProcess ( int AtulProcessID, int CreatedBy, int OwnedBy, int AtulProcessStatusID ) : string
AtulProcessID int The atul process ID.
CreatedBy int The created by.
OwnedBy int The owned by.
AtulProcessStatusID int The atul process status ID.
return string

InsertInstanceProcess() public method

Inserts the instance process.
public InsertInstanceProcess ( string AtulProcessID, string CreatedBy, string OwnedBy, string AtulProcessStatusID ) : string
AtulProcessID string The atul process ID.
CreatedBy string The created by.
OwnedBy string The owned by.
AtulProcessStatusID string The atul process status ID.
return string

InsertInstanceProcessActivity() public method

Inserts the instance process activity.
public InsertInstanceProcessActivity ( int AtulInstanceProcessID, int AtulProcessActivityID, int InstanceProcessActivityCompletedBy, int CreatedBy ) : string
AtulInstanceProcessID int The atul instance process ID.
AtulProcessActivityID int The atul process activity ID.
InstanceProcessActivityCompletedBy int The instance process activity completed by.
CreatedBy int The created by.
return string

InsertInstanceProcessActivity() public method

Inserts the instance process activity.
public InsertInstanceProcessActivity ( string AtulInstanceProcessID, string AtulProcessActivityID, string InstanceProcessActivityCompletedBy, string CreatedBy ) : string
AtulInstanceProcessID string The atul instance process ID.
AtulProcessActivityID string The atul process activity ID.
InstanceProcessActivityCompletedBy string The instance process activity completed by.
CreatedBy string The created by.
return string

SetActivityDeadLine() public method

Sets the activity dead line.
public SetActivityDeadLine ( ) : string
return string

SetActivityManMinutes() public method

Sets the activity man minutes. TODO: Add man minute column, update proc(s)
public SetActivityManMinutes ( ) : string
return string

SetActivityPrerequsiteActivityGroup() public method

Sets the activity prerequsite activity group. TODO: Request proc to set prereq group Params: ActivityID, GroupID
public SetActivityPrerequsiteActivityGroup ( ) : string
return string

UpdateInstanceProcess() public method

Updates the instance process.
public UpdateInstanceProcess ( int AtulInstanceProcessID, int AtulProcessID, int ModifiedBy, int OwnedBy, int AtulProcessStatusID ) : string
AtulInstanceProcessID int The atul instance process ID.
AtulProcessID int The atul process ID.
ModifiedBy int The modified by.
OwnedBy int The owned by.
AtulProcessStatusID int The atul process status ID.
return string

UpdateInstanceProcess() public method

Updates the instance process.
public UpdateInstanceProcess ( string AtulInstanceProcessID, string AtulProcessID, string ModifiedBy, string OwnedBy, string AtulProcessStatusID ) : string
AtulInstanceProcessID string The atul instance process ID.
AtulProcessID string The atul process ID.
ModifiedBy string The modified by.
OwnedBy string The owned by.
AtulProcessStatusID string The atul process status ID.
return string

UpdateInstanceProcessActivity() public method

Updates the instance process activity.
public UpdateInstanceProcessActivity ( int AtulInstanceProcessActivityID, int AtulInstanceProcessID, int AtulProcessActivityID, int ProcessActivityCompleted, int ProcessActivityDidNotApply, int ProcessActivityDeadlineMissed, int InstanceProcessActivityCompletedBy, int ModifiedBy ) : string
AtulInstanceProcessActivityID int The atul instance process activity ID.
AtulInstanceProcessID int The atul instance process ID.
AtulProcessActivityID int The atul process activity ID.
ProcessActivityCompleted int The process activity completed.
ProcessActivityDidNotApply int The process activity did not apply.
ProcessActivityDeadlineMissed int The process activity deadline missed.
InstanceProcessActivityCompletedBy int The instance process activity completed by.
ModifiedBy int The modified by.
return string

UpdateInstanceProcessActivity() public method

Updates the instance process activity.
public UpdateInstanceProcessActivity ( string AtulInstanceProcessActivityID, string AtulInstanceProcessID, string AtulProcessActivityID, string ProcessActivityCompleted, string ProcessActivityDidNotApply, string ProcessActivityDeadlineMissed, string InstanceProcessActivityCompletedBy, string ModifiedBy ) : string
AtulInstanceProcessActivityID string The atul instance process activity ID.
AtulInstanceProcessID string The atul instance process ID.
AtulProcessActivityID string The atul process activity ID.
ProcessActivityCompleted string The process activity completed.
ProcessActivityDidNotApply string The process activity did not apply.
ProcessActivityDeadlineMissed string The process activity deadline missed.
InstanceProcessActivityCompletedBy string The instance process activity completed by.
ModifiedBy string The modified by.
return string

UpdateRunningProcessSpecification() public method

Updates the running process specification. TODO: MAtch to docs, discuss with Cory
public UpdateRunningProcessSpecification ( ) : string
return string