Heracles.ts

@hydra-cg/heracles.ts > TemplatedOperation

Class: TemplatedOperation

Provides a default implementation of the ITemplatedOperation interface.

class:

Hierarchy

TemplatedResource<IOperation>

↳ TemplatedOperation

Implements

• ITemplatedResource<IOperation>
• ITemplatedOperation

Index

Constructors

• constructor

Properties

• baseUrl
• collections
• expectedHeaders
• expects
• iri
• links
• method
• operations
• returnedHeaders
• returns
• target
• type
• id

Methods

• createInstance
• expandTarget
• getNextIri

---

Constructors

constructor

⊕ new TemplatedOperation(operationResource: IOperation, template: IIriTemplate): TemplatedOperation

Overrides TemplatedResource.constructor

Defined in DataModel/TemplatedOperation.ts:31

Initializes a new instance of the TemplatedOperation class.

Parameters:

Name	Type	Description
operationResource	IOperation	Original operation to create templated one from.
template	IIriTemplate	IRI template to take template from.

Returns: TemplatedOperation

---

Properties

baseUrl

● baseUrl: string

Implementation of ITemplatedOperation.baseUrl

Inherited from TemplatedResource.baseUrl

Defined in DataModel/TemplatedResource.ts:22

Gets a base URL that can be used to resolve target in case it is relative.

readonly:

returns:

---

collections

● collections: ResourceFilterableCollection<ICollection>

Implementation of ITemplatedOperation.collections

Inherited from TemplatedResource.collections

Defined in DataModel/TemplatedResource.ts:40

Gets collections exposed by that resource.

readonly:

returns:

---

expectedHeaders

● expectedHeaders: Iterable<string>

Implementation of ITemplatedOperation.expectedHeaders

Defined in DataModel/TemplatedOperation.ts:28

Gets the expected headers.

readonly:

returns:

---

expects

● expects: ResourceFilterableCollection<IClass>

Implementation of ITemplatedOperation.expects

Defined in DataModel/TemplatedOperation.ts:22

Gets the expected classes.

readonly:

returns:

---

iri

● iri: string

Implementation of ITemplatedOperation.iri

Inherited from TemplatedResource.iri

Defined in DataModel/TemplatedResource.ts:25

Gets an Iri of a resource.

readonly:

returns:

---

links

● links: LinksCollection

Implementation of ITemplatedOperation.links

Inherited from TemplatedResource.links

Defined in DataModel/TemplatedResource.ts:37

Gets links related to that resource.

readonly:

returns:

---

method

● method: string

Implementation of ITemplatedOperation.method

Defined in DataModel/TemplatedOperation.ts:19

Gets a method to be used for the call.

readonly:

returns:

---

operations

● operations: OperationsCollection

Implementation of ITemplatedOperation.operations

Inherited from TemplatedResource.operations

Defined in DataModel/TemplatedResource.ts:34

Gets operations that can be performed on that resource.

readonly:

returns:

---

returnedHeaders

● returnedHeaders: Iterable<string>

Implementation of ITemplatedOperation.returnedHeaders

Defined in DataModel/TemplatedOperation.ts:31

Gets the returned headers.

readonly:

returns:

---

returns

● returns: ResourceFilterableCollection<IClass>

Implementation of ITemplatedOperation.returns

Defined in DataModel/TemplatedOperation.ts:25

Gets the returned classes.

readonly:

returns:

---

target

● target: IResource

Implementation of ITemplatedOperation.target

Inherited from TemplatedResource.target

Defined in DataModel/TemplatedResource.ts:31

Gets a target URL to be called.

readonly:

returns:

---

type

● type: TypesCollection

Implementation of ITemplatedOperation.type

Inherited from TemplatedResource.type

Defined in DataModel/TemplatedResource.ts:28

Gets classes a given resource is of.

readonly:

returns:

---

<Static><Private> id

● id: number = 0

Defined in DataModel/TemplatedOperation.ts:16

---

Methods

<Protected> createInstance

▸ createInstance(resource: IPointingResource): IOperation

Overrides TemplatedResource.createInstance

Defined in DataModel/TemplatedOperation.ts:47

Parameters:

Name	Type
resource	IPointingResource

Returns: IOperation

---

expandTarget

▸ expandTarget(mappedVariables: IDictionary<string> | MappingBuilder): IOperation

Implementation of ITemplatedOperation.expandTarget

Inherited from TemplatedResource.expandTarget

Defined in DataModel/TemplatedResource.ts:64

Expands an URI template with given variables.

Parameters:

Name	Type
mappedVariables	IDictionary<string> | MappingBuilder

Returns: IOperation

---

<Protected> getNextIri

▸ getNextIri(): string

Overrides TemplatedResource.getNextIri

Defined in DataModel/TemplatedOperation.ts:58

Returns: string

---

This site is open source. Improve this page.