activity/streams/vocab/gen_property_startIndex_interface.go
2019-01-29 22:28:40 +01:00

70 行
2.6 KiB
Go

package vocab
import "net/url"
// A non-negative integer value identifying the relative position within the
// logical view of a strictly ordered collection.
//
// Example 132 (https://www.w3.org/TR/activitystreams-vocabulary/#ex150-jsonld):
// {
// "orderedItems": [
// {
// "name": "Density of Water",
// "type": "Note"
// },
// {
// "name": "Air Mattress Idea",
// "type": "Note"
// }
// ],
// "startIndex": 0,
// "summary": "Page 1 of Sally's notes",
// "type": "OrderedCollectionPage"
// }
type StartIndexPropertyInterface interface {
// Clear ensures no value of this property is set. Calling
// IsNonNegativeInteger afterwards will return false.
Clear()
// Get returns the value of this property. When IsNonNegativeInteger
// returns false, Get will return any arbitrary value.
Get() int
// GetIRI returns the IRI of this property. When IsIRI returns false,
// GetIRI will return any arbitrary value.
GetIRI() *url.URL
// HasAny returns true if the value or IRI is set.
HasAny() bool
// IsIRI returns true if this property is an IRI.
IsIRI() bool
// IsNonNegativeInteger returns true if this property is set and not an
// IRI.
IsNonNegativeInteger() bool
// JSONLDContext returns the JSONLD URIs required in the context string
// for this property and the specific values that are set. The value
// in the map is the alias used to import the property's value or
// values.
JSONLDContext() map[string]string
// KindIndex computes an arbitrary value for indexing this kind of value.
// This is a leaky API detail only for folks looking to replace the
// go-fed implementation. Applications should not use this method.
KindIndex() int
// LessThan compares two instances of this property with an arbitrary but
// stable comparison. Applications should not use this because it is
// only meant to help alternative implementations to go-fed to be able
// to normalize nonfunctional properties.
LessThan(o StartIndexPropertyInterface) bool
// Name returns the name of this property: "startIndex".
Name() string
// Serialize converts this into an interface representation suitable for
// marshalling into a text or binary format. Applications should not
// need this function as most typical use cases serialize types
// instead of individual properties. It is exposed for alternatives to
// go-fed implementations to use.
Serialize() (interface{}, error)
// Set sets the value of this property. Calling IsNonNegativeInteger
// afterwards will return true.
Set(v int)
// SetIRI sets the value of this property. Calling IsIRI afterwards will
// return true.
SetIRI(v *url.URL)
}