@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

package/data/script-api/dw.util.SeekableIterator.md

@@ -0,0 +1,187 @@
+<!-- prettier-ignore-start -->
+# Class SeekableIterator
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Iterator](dw.util.Iterator.md)
+    - [dw.util.SeekableIterator](dw.util.SeekableIterator.md)
+
+A special Iterator, which is returned by the system to iterate through large
+sets of data. The iterator supports seeking forward to a random position.
+This is a typical action when paging forward in a result set. The Iterator is
+primarily returned from search operations.
+
+
+Starting with API version 10.6, these iterators can only
+be iterated once to avoid possible memory problems for really large
+result sets. Putting them into the pipeline dictionary and trying to loop them
+multiple times is no longer possible because this would require buffering the
+iterated elements internally.
+
+
+Prior to 10.6, and for all customers still running API version 10.4
+(compatibility mode), SeekableIterator instances stored in the pipeline
+dictionary could be iterated multiple times (for example, by several loop
+nodes).
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [count](#count): [Number](TopLevel.Number.md) `(read-only)` | Returns the total element count for this iterator. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [asList](dw.util.SeekableIterator.md#aslistnumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Returns a list representing a subsequence within the iterator. |
+| [close](dw.util.SeekableIterator.md#close)() | Closes all system resources associated with this iterator. |
+| [first](dw.util.SeekableIterator.md#first)() | Returns the first element of this iterator and closes it. |
+| [forward](dw.util.SeekableIterator.md#forwardnumber)([Number](TopLevel.Number.md)) | Seeks forward by the given number of elements. |
+| [forward](dw.util.SeekableIterator.md#forwardnumber-number)([Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Seeks forward by the given number of elements and limits the  iteration to the given number of elements. |
+| [getCount](dw.util.SeekableIterator.md#getcount)() | Returns the total element count for this iterator. |
+| [hasNext](dw.util.SeekableIterator.md#hasnext)() | Indicates if there are more elements. |
+| [next](dw.util.SeekableIterator.md#next)() | Returns the next element from the Iterator. |
+
+### Methods inherited from class Iterator
+
+[asList](dw.util.Iterator.md#aslist), [asList](dw.util.Iterator.md#aslistnumber-number), [hasNext](dw.util.Iterator.md#hasnext), [next](dw.util.Iterator.md#next)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### count
+- count: [Number](TopLevel.Number.md) `(read-only)`
+  - : Returns the total element count for this iterator. The
+      method returns -1, if the total count is not known.
+
+
+
+---
+
+## Method Details
+
+### asList(Number, Number)
+- asList(start: [Number](TopLevel.Number.md), size: [Number](TopLevel.Number.md)): [List](dw.util.List.md)
+  - : Returns a list representing a subsequence within the iterator. The underlying
+      system resources of the iterator will be closed at the end. The start
+      position must be 0 or a positive number.
+
+
+    **Parameters:**
+    - start - the position from which to start the subsequence.
+    - size - the number of items to collect.
+
+    **Returns:**
+    - the list containing the subsequence.
+
+
+---
+
+### close()
+- close(): void
+  - : Closes all system resources associated with this iterator.
+      
+      
+      Calling this method is strongly recommended if not all elements of this iterator are
+      retrieved. This will allow the system to release system resources immediately.
+      The `SeekableIterator` is closed automatically if all elements are retrieved.
+      Then calling method `close()` is optional.
+
+
+
+---
+
+### first()
+- first(): [Object](TopLevel.Object.md)
+  - : Returns the first element of this iterator and closes it.
+      
+      
+      If the iterator does not contain another element `null` is returned.
+      If any of the methods next(), forward(int) or forward(int,int) have been called before
+      `null` is returned.
+      This method is useful if only the first element of an iterator is needed.
+      
+      
+      A possible example for the use of first() is:
+      
+      `OrderMgr.queryOrders("queryString", "sortString", args).first()`
+
+
+    **Returns:**
+    - the first element of an iterator and closes the iterator
+      or returns `null` if the iterator doesn't have another element
+      or the methods next(), forward(int) or forward(int,int) have already been called.
+
+
+
+---
+
+### forward(Number)
+- forward(n: [Number](TopLevel.Number.md)): void
+  - : Seeks forward by the given number of elements. The number of
+      seek steps must be 0 or a positive number.
+
+
+    **Parameters:**
+    - n - the number of elements to seek forward.
+
+
+---
+
+### forward(Number, Number)
+- forward(n: [Number](TopLevel.Number.md), size: [Number](TopLevel.Number.md)): void
+  - : Seeks forward by the given number of elements and limits the
+      iteration to the given number of elements. The method is typically
+      used to position and trim an iterator for paging. The getCount()
+      method will still return the total count of the underlying data
+      collection.
+
+
+    **Parameters:**
+    - n - the number of elements to seek forward.
+    - size - the maximum number of elements return from the iterator
+
+
+---
+
+### getCount()
+- getCount(): [Number](TopLevel.Number.md)
+  - : Returns the total element count for this iterator. The
+      method returns -1, if the total count is not known.
+
+
+    **Returns:**
+    - the total element count for this iterator or -1.
+
+
+---
+
+### hasNext()
+- hasNext(): [Boolean](TopLevel.Boolean.md)
+  - : Indicates if there are more elements.
+
+    **Returns:**
+    - true if there are more elements,
+      false otherwise.
+
+
+
+---
+
+### next()
+- next(): [Object](TopLevel.Object.md)
+  - : Returns the next element from the Iterator.
+
+    **Returns:**
+    - the next element from the Iterator.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.util.Set.md

@@ -0,0 +1,39 @@
+<!-- prettier-ignore-start -->
+# Class Set
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Collection](dw.util.Collection.md)
+    - [dw.util.Set](dw.util.Set.md)
+
+Represents a set of objects.
+
+
+## All Known Subclasses
+[HashSet](dw.util.HashSet.md), [LinkedHashSet](dw.util.LinkedHashSet.md), [SortedSet](dw.util.SortedSet.md)
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [EMPTY_SET](#empty_set): [Set](dw.util.Set.md) | Convenience variable, for an empty and immutable list. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+### Methods inherited from class Collection
+
+[add](dw.util.Collection.md#addobject), [add1](dw.util.Collection.md#add1object), [addAll](dw.util.Collection.md#addallcollection), [clear](dw.util.Collection.md#clear), [contains](dw.util.Collection.md#containsobject), [containsAll](dw.util.Collection.md#containsallcollection), [getLength](dw.util.Collection.md#getlength), [isEmpty](dw.util.Collection.md#isempty), [iterator](dw.util.Collection.md#iterator), [remove](dw.util.Collection.md#removeobject), [removeAll](dw.util.Collection.md#removeallcollection), [retainAll](dw.util.Collection.md#retainallcollection), [size](dw.util.Collection.md#size), [toArray](dw.util.Collection.md#toarray), [toArray](dw.util.Collection.md#toarraynumber-number)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### EMPTY_SET
+- EMPTY_SET: [Set](dw.util.Set.md)
+  - : Convenience variable, for an empty and immutable list.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.util.SortedMap.md

@@ -0,0 +1,148 @@
+<!-- prettier-ignore-start -->
+# Class SortedMap
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Map](dw.util.Map.md)
+    - [dw.util.SortedMap](dw.util.SortedMap.md)
+
+A map that further guarantees that it will be in ascending key order,
+sorted according to the natural ordering of its keys,
+or by a comparator provided at sorted map creation time. This order is reflected
+when iterating over the sorted map's collection views (returned by the entrySet,
+keySet and values methods).
+Note that sorting by natural order is only supported for Number,
+String, Date, Money and Quantity as key.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [SortedMap](#sortedmap)() | Constructor to create a new SortedMap. |
+| [SortedMap](#sortedmapobject)([Object](TopLevel.Object.md)) | Constructor to create a new SortedMap. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [clone](dw.util.SortedMap.md#clone)() | Returns a shallow copy of this map. |
+| [firstKey](dw.util.SortedMap.md#firstkey)() | Returns the first (lowest) key currently in this sorted map. |
+| [headMap](dw.util.SortedMap.md#headmapobject)([Object](TopLevel.Object.md)) | Returns a view of the portion of this map whose keys are strictly less than toKey. |
+| [lastKey](dw.util.SortedMap.md#lastkey)() | Returns the last (highest) key currently in this sorted map. |
+| [subMap](dw.util.SortedMap.md#submapobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Returns a view of the portion of this map whose keys range from fromKey, inclusive,  to toKey, exclusive. |
+| [tailMap](dw.util.SortedMap.md#tailmapobject)([Object](TopLevel.Object.md)) | Returns a view of the portion of this map whose keys are greater than or equal  to fromKey. |
+
+### Methods inherited from class Map
+
+[clear](dw.util.Map.md#clear), [containsKey](dw.util.Map.md#containskeyobject), [containsValue](dw.util.Map.md#containsvalueobject), [entrySet](dw.util.Map.md#entryset), [get](dw.util.Map.md#getobject), [getLength](dw.util.Map.md#getlength), [isEmpty](dw.util.Map.md#isempty), [keySet](dw.util.Map.md#keyset), [put](dw.util.Map.md#putobject-object), [putAll](dw.util.Map.md#putallmap), [remove](dw.util.Map.md#removeobject), [size](dw.util.Map.md#size), [values](dw.util.Map.md#values---variant-1), [values](dw.util.Map.md#values---variant-2)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constructor Details
+
+### SortedMap()
+- SortedMap()
+  - : Constructor to create a new SortedMap.
+
+
+---
+
+### SortedMap(Object)
+- SortedMap(comparator: [Object](TopLevel.Object.md))
+  - : Constructor to create a new SortedMap.
+      
+      The constructor takes a compare function as additional parameter. This comparator
+      determines identity and the order of the element keys for this map.
+      The order of the elements is determined with a comparator (see [PropertyComparator](dw.util.PropertyComparator.md))
+      or with the help of the given function. The function must take two parameters
+      and return a value <=-1 if the first parameter is smaller than the second,
+      a value if >=1 if the first one is greater than the second parameter
+      and a value in between like 0 if both are equal.
+
+
+    **Parameters:**
+    - comparator - an instance of a PropertyComparator or a comparison function
+
+
+---
+
+## Method Details
+
+### clone()
+- clone(): [SortedMap](dw.util.SortedMap.md)
+  - : Returns a shallow copy of this map.
+
+    **Returns:**
+    - a shallow copy of this map.
+
+
+---
+
+### firstKey()
+- firstKey(): [Object](TopLevel.Object.md)
+  - : Returns the first (lowest) key currently in this sorted map.
+
+    **Returns:**
+    - the first (lowest) key currently in this sorted map.
+
+
+---
+
+### headMap(Object)
+- headMap(key: [Object](TopLevel.Object.md)): [SortedMap](dw.util.SortedMap.md)
+  - : Returns a view of the portion of this map whose keys are strictly less than toKey.
+
+    **Parameters:**
+    - key - high endpoint (exclusive) of the headMap.
+
+    **Returns:**
+    - a view of the portion of this map whose keys are strictly less than toKey.
+
+
+---
+
+### lastKey()
+- lastKey(): [Object](TopLevel.Object.md)
+  - : Returns the last (highest) key currently in this sorted map.
+
+    **Returns:**
+    - the last (highest) key currently in this sorted map.
+
+
+---
+
+### subMap(Object, Object)
+- subMap(from: [Object](TopLevel.Object.md), to: [Object](TopLevel.Object.md)): [SortedMap](dw.util.SortedMap.md)
+  - : Returns a view of the portion of this map whose keys range from fromKey, inclusive,
+      to toKey, exclusive. (If fromKey and toKey are equal, the returned sorted map is empty.)
+
+
+    **Parameters:**
+    - from - low endpoint (inclusive) of the subMap.
+    - to - high endpoint (exclusive) of the subMap.
+
+    **Returns:**
+    - a view of the portion of this map whose keys range from fromKey, inclusive, to toKey, exclusive.
+
+
+---
+
+### tailMap(Object)
+- tailMap(key: [Object](TopLevel.Object.md)): [SortedMap](dw.util.SortedMap.md)
+  - : Returns a view of the portion of this map whose keys are greater than or equal
+      to fromKey. The returned sorted map is backed by this map, so changes in the
+      returned sorted map are reflected in this map, and vice-versa. The returned
+      sorted map supports all optional map operations.
+
+
+    **Parameters:**
+    - key - low endpoint (inclusive) of the tailMap.
+
+    **Returns:**
+    - a view of the portion of this map whose keys are greater than or equal to fromKey.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.util.SortedSet.md

@@ -0,0 +1,173 @@
+<!-- prettier-ignore-start -->
+# Class SortedSet
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.util.Collection](dw.util.Collection.md)
+    - [dw.util.Set](dw.util.Set.md)
+      - [dw.util.SortedSet](dw.util.SortedSet.md)
+
+A set that further guarantees that its iterator
+will traverse the set in ascending element order,
+sorted according to the natural ordering of its
+elements (only supported for Number, String,
+Date, Money and Quantity), or by a comparator
+provided at sorted set creation time.
+
+
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [SortedSet](#sortedset)() | Constructor to create a new SortedSet. |
+| [SortedSet](#sortedsetobject)([Object](TopLevel.Object.md)) | Constructor to create a new SortedSet. |
+| [SortedSet](#sortedsetcollection)([Collection](dw.util.Collection.md)) | Constructor for a new SortedSet. |
+
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [clone](dw.util.SortedSet.md#clone)() | Returns a shallow copy of this set. |
+| [first](dw.util.SortedSet.md#first)() | Returns the first (lowest) element currently in this sorted set. |
+| [headSet](dw.util.SortedSet.md#headsetobject)([Object](TopLevel.Object.md)) | Returns a view of the portion of this sorted set whose elements  are strictly less than toElement. |
+| [last](dw.util.SortedSet.md#last)() | Returns the last (highest) element currently in this sorted set. |
+| [subSet](dw.util.SortedSet.md#subsetobject-object)([Object](TopLevel.Object.md), [Object](TopLevel.Object.md)) | Returns a view of the portion of this sorted set whose elements  range from fromElement, inclusive, to toElement, exclusive. |
+| [tailSet](dw.util.SortedSet.md#tailsetobject)([Object](TopLevel.Object.md)) | Returns a view of the portion of this sorted set whose elements  are greater than or equal to fromElement. |
+
+### Methods inherited from class Collection
+
+[add](dw.util.Collection.md#addobject), [add1](dw.util.Collection.md#add1object), [addAll](dw.util.Collection.md#addallcollection), [clear](dw.util.Collection.md#clear), [contains](dw.util.Collection.md#containsobject), [containsAll](dw.util.Collection.md#containsallcollection), [getLength](dw.util.Collection.md#getlength), [isEmpty](dw.util.Collection.md#isempty), [iterator](dw.util.Collection.md#iterator), [remove](dw.util.Collection.md#removeobject), [removeAll](dw.util.Collection.md#removeallcollection), [retainAll](dw.util.Collection.md#retainallcollection), [size](dw.util.Collection.md#size), [toArray](dw.util.Collection.md#toarray), [toArray](dw.util.Collection.md#toarraynumber-number)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constructor Details
+
+### SortedSet()
+- SortedSet()
+  - : Constructor to create a new SortedSet.
+
+
+---
+
+### SortedSet(Object)
+- SortedSet(comparator: [Object](TopLevel.Object.md))
+  - : Constructor to create a new SortedSet.
+      
+      The constructor takes a compare function as additional parameter. This comparator
+      determines identity and the order of the elements for this set.
+      The order of the elements is determined with a comparator (see [PropertyComparator](dw.util.PropertyComparator.md))
+      or with the help of the given function. The function must take two parameters
+      and return a value <=-1 if the first parameter is smaller than the second,
+      a value if >=1 if the first one is greater than the second parameter
+      and a value in between like 0 if both are equal.
+
+
+    **Parameters:**
+    - comparator - an instance of a PropertyComparator or a comparison function
+
+
+---
+
+### SortedSet(Collection)
+- SortedSet(collection: [Collection](dw.util.Collection.md))
+  - : Constructor for a new SortedSet. The constructor
+      initializes the SortedSet with the elements of the
+      given collection.
+
+
+    **Parameters:**
+    - collection - the collection of objects that are  inserted into the set.
+
+
+---
+
+## Method Details
+
+### clone()
+- clone(): [SortedSet](dw.util.SortedSet.md)
+  - : Returns a shallow copy of this set.
+
+    **Returns:**
+    - a shallow copy of this set.
+
+
+---
+
+### first()
+- first(): [Object](TopLevel.Object.md)
+  - : Returns the first (lowest) element currently in this sorted set.
+
+    **Returns:**
+    - the first (lowest) element currently in this sorted set.
+
+
+---
+
+### headSet(Object)
+- headSet(key: [Object](TopLevel.Object.md)): [SortedSet](dw.util.SortedSet.md)
+  - : Returns a view of the portion of this sorted set whose elements
+      are strictly less than toElement. The returned sorted set is
+      backed by this sorted set, so changes in the returned sorted
+      set are reflected in this sorted set, and vice-versa. The returned
+      sorted set supports all optional set operations.
+
+
+    **Parameters:**
+    - key - high endpoint (exclusive) of the headSet.
+
+    **Returns:**
+    - a view of the specified initial range of this sorted set.
+
+
+---
+
+### last()
+- last(): [Object](TopLevel.Object.md)
+  - : Returns the last (highest) element currently in this sorted set.
+
+    **Returns:**
+    - the last (highest) element currently in this sorted set.
+
+
+---
+
+### subSet(Object, Object)
+- subSet(from: [Object](TopLevel.Object.md), to: [Object](TopLevel.Object.md)): [SortedSet](dw.util.SortedSet.md)
+  - : Returns a view of the portion of this sorted set whose elements
+      range from fromElement, inclusive, to toElement, exclusive. (If
+      fromElement and toElement are equal, the returned sorted set is empty.)
+      The returned sorted set is backed by this sorted set, so changes in
+      the returned sorted set are reflected in this sorted set, and vice-versa.
+      The returned sorted set supports all optional set operations that this
+      sorted set supports.
+
+
+    **Parameters:**
+    - from - low endpoint (inclusive) of the subSet.
+    - to - high endpoint (exclusive) of the subSet.
+
+    **Returns:**
+    - a view of the specified range within this sorted set.
+
+
+---
+
+### tailSet(Object)
+- tailSet(key: [Object](TopLevel.Object.md)): [SortedSet](dw.util.SortedSet.md)
+  - : Returns a view of the portion of this sorted set whose elements
+      are greater than or equal to fromElement. The returned sorted set
+      is backed by this sorted set, so changes in the returned sorted
+      set are reflected in this sorted set, and vice-versa. The returned
+      sorted set supports all optional set operations.
+
+
+    **Parameters:**
+    - key - low endpoint (inclusive) of the tailSet.
+
+    **Returns:**
+    - a view of the specified final range of this sorted set.
+
+
+---
+
+<!-- prettier-ignore-end -->