Class CaseFlags

Index

Case Flags

add delete deleteAll getForCase search

Case Flags

add

add(
    caObjectId: number,
    flagId: number,
    severity: string,
    appliedBy: number,
    DateApplied: Date,
    options?: {
        CompletedBy?: number;
        DateCompleted?: Date;
        DisciplineId?: number;
        Notes?: string;
    },
): Promise<unknown>
Add flag to case
Parameters
- caObjectId: number
  The Case Object to add the flag to.
- flagId: number
  The flag ID
- severity: string
  The severity of the flag
- appliedBy: number
  Which userID is applying the flag
- DateApplied: Date
  The date that the flag should be applied
- Optionaloptions: {
      CompletedBy?: number;
      DateCompleted?: Date;
      DisciplineId?: number;
      Notes?: string;
  }
  Options for CaseFlags includes Notes, DisciplineId, CompletedBy, DateCompleted
Returns Promise<unknown>
Returns Promise that represents an object describing CaFlag.
- Defined in case_flags.ts:30

delete

delete(caFlagId: number): Promise<unknown>
Delete specific flag from case
Parameters
- caFlagId: number
Returns Promise<unknown>
Returns Promise that represents the CaFlag that has been deleted.
- Defined in case_flags.ts:58

deleteAll

deleteAll(caObjectId: number): Promise<unknown>
Delete all flags from case
Parameters
- caObjectId: number
  The Case Object to detach the flags from.
Returns Promise<unknown>
Returns Promise that represents the number of flags deleted from the case provided.
- Defined in case_flags.ts:78

getForCase

getForCase(caObjectId: number): Promise<unknown>
Get flags attached to a specific case
Parameters
- caObjectId: number
  The Case Object from which to get attached flags
Returns Promise<unknown>
Returns Promise that represents a collection of the default CaFlags.
- Defined in case_flags.ts:98

search

search(filters?: Object): Promise<unknown>
Search for Case Flags. Include one or more of the search fields. A logical 'and' operation is applied to muliple search fields
Parameters
- Optionalfilters: Object
  The parameters to search by. (CaFlagId, Flag, FlagDesc)
Returns Promise<unknown>
Returns Promise that represents an Array of resulting Flags
- Defined in case_flags.ts:119