Home Manual Reference Source Test Repository

import OperationType from 'opengate-js/src/operationTypes/OperationType.js'

public class | source

OperationType

Extends:

BaseProvision → OperationType

This is a base object that contains all you can do about OperationType.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	applicableTo(applicableTo: array): OperationType Allows the modification of the applicableTo
public	create(): Promise Create a new Rule
public	delete(): Promise Deletes the selected RuleConfiguration
public	fromCatalog(fromCatalog: string): OperationType Set the catalog
public	update(): Promise Udpate a Rule
public	withDescription(description: string): OperationType Set the description attribute
public	withIdentifier(name: string): OperationType Set the name for update attribute
public	withModels(models: array): OperationType Allows the modification of the allowed models
public	withName(name: string): OperationType Set the name attribute
public	withOrganization(organization: string): OperationType Set the organization attribute
public	withParameters(parameters: array): OperationType Allows the modification of the parameters
public	withProfiles(profiles: array): OperationType Allows the modification of the profiles allowed
public	withSteps(steps: array): OperationType Allows the modification of the steps
public	withTitle(title: string): OperationType Set the title attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public applicableTo(applicableTo: array): OperationType source

Allows the modification of the applicableTo

Params:

Name	Type	Attribute	Description
applicableTo	array

Return:

public create(): Promise source

Create a new Rule

Override:

BaseProvision#create

Return:

Throw:

public delete(): Promise source

Deletes the selected RuleConfiguration

Override:

BaseProvision#delete

Return:

Throw:

public fromCatalog(fromCatalog: string): OperationType source

Set the catalog

Params:

Name	Type	Attribute	Description
fromCatalog	string

Return:

public update(): Promise source

Udpate a Rule

Override:

BaseProvision#update

Return:

Throw:

public withDescription(description: string): OperationType source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

public withIdentifier(name: string): OperationType source

Set the name for update attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

public withModels(models: array): OperationType source

Allows the modification of the allowed models

Params:

Name	Type	Attribute	Description
models	array

Return:

public withName(name: string): OperationType source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

public withOrganization(organization: string): OperationType source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

public withParameters(parameters: array): OperationType source

Allows the modification of the parameters

Params:

Name	Type	Attribute	Description
parameters	array

Return:

public withProfiles(profiles: array): OperationType source

Allows the modification of the profiles allowed

Params:

Name	Type	Attribute	Description
profiles	array

Return:

public withSteps(steps: array): OperationType source

Allows the modification of the steps

Params:

Name	Type	Attribute	Description
steps	array

Return:

public withTitle(title: string): OperationType source

Set the title attribute

Params:

Name	Type	Attribute	Description
title	string		required field

Return: