gen_property_forgefed_dependedBy_interface.go

// Code generated by astool. DO NOT EDIT.

package vocab

import "net/url"

// ForgeFedDependedByPropertyIterator represents a single value for the
// "dependedBy" property.
type ForgeFedDependedByPropertyIterator interface {
	// Get returns the value of this property. When IsForgeFedTicket returns
	// false, Get will return any arbitrary value.
	Get() ForgeFedTicket
	// GetIRI returns the IRI of this property. When IsIRI returns false,
	// GetIRI will return any arbitrary value.
	GetIRI() *url.URL
	// GetType returns the value in this property as a Type. Returns nil if
	// the value is not an ActivityStreams type, such as an IRI or another
	// value.
	GetType() Type
	// HasAny returns true if the value or IRI is set.
	HasAny() bool
	// IsForgeFedTicket returns true if this property is set and not an IRI.
	IsForgeFedTicket() bool
	// IsIRI returns true if this property is an IRI.
	IsIRI() 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 ForgeFedDependedByPropertyIterator) bool
	// Name returns the name of this property: "ForgeFedDependedBy".
	Name() string
	// Next returns the next iterator, or nil if there is no next iterator.
	Next() ForgeFedDependedByPropertyIterator
	// Prev returns the previous iterator, or nil if there is no previous
	// iterator.
	Prev() ForgeFedDependedByPropertyIterator
	// Set sets the value of this property. Calling IsForgeFedTicket
	// afterwards will return true.
	Set(v ForgeFedTicket)
	// SetIRI sets the value of this property. Calling IsIRI afterwards will
	// return true.
	SetIRI(v *url.URL)
	// SetType attempts to set the property for the arbitrary type. Returns an
	// error if it is not a valid type to set on this property.
	SetType(t Type) error
}

// Identifies one or more tickets which depend on this Ticket, i.e. they can’t
// be resolved without this tickets being resolved too.
type ForgeFedDependedByProperty interface {
	// AppendForgeFedTicket appends a Ticket value to the back of a list of
	// the property "dependedBy". Invalidates iterators that are
	// traversing using Prev.
	AppendForgeFedTicket(v ForgeFedTicket)
	// AppendIRI appends an IRI value to the back of a list of the property
	// "dependedBy"
	AppendIRI(v *url.URL)
	// PrependType prepends an arbitrary type value to the front of a list of
	// the property "dependedBy". Invalidates iterators that are
	// traversing using Prev. Returns an error if the type is not a valid
	// one to set for this property.
	AppendType(t Type) error
	// At returns the property value for the specified index. Panics if the
	// index is out of bounds.
	At(index int) ForgeFedDependedByPropertyIterator
	// Begin returns the first iterator, or nil if empty. Can be used with the
	// iterator's Next method and this property's End method to iterate
	// from front to back through all values.
	Begin() ForgeFedDependedByPropertyIterator
	// Empty returns returns true if there are no elements.
	Empty() bool
	// End returns beyond-the-last iterator, which is nil. Can be used with
	// the iterator's Next method and this property's Begin method to
	// iterate from front to back through all values.
	End() ForgeFedDependedByPropertyIterator
	// InsertForgeFedTicket inserts a Ticket value at the specified index for
	// a property "dependedBy". Existing elements at that index and higher
	// are shifted back once. Invalidates all iterators.
	InsertForgeFedTicket(idx int, v ForgeFedTicket)
	// Insert inserts an IRI value at the specified index for a property
	// "dependedBy". Existing elements at that index and higher are
	// shifted back once. Invalidates all iterators.
	InsertIRI(idx int, v *url.URL)
	// PrependType prepends an arbitrary type value to the front of a list of
	// the property "dependedBy". Invalidates all iterators. Returns an
	// error if the type is not a valid one to set for this property.
	InsertType(idx int, t Type) error
	// 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 method specifically needed only for alternate
	// implementations for go-fed. Applications should not use this
	// method. Panics if the index is out of bounds.
	KindIndex(idx int) int
	// Len returns the number of values that exist for the "dependedBy"
	// property.
	Len() (length int)
	// Less computes whether another property is less than this one. Mixing
	// types results in a consistent but arbitrary ordering
	Less(i, j int) bool
	// 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 ForgeFedDependedByProperty) bool
	// Name returns the name of this property ("dependedBy") with any alias.
	Name() string
	// PrependForgeFedTicket prepends a Ticket value to the front of a list of
	// the property "dependedBy". Invalidates all iterators.
	PrependForgeFedTicket(v ForgeFedTicket)
	// PrependIRI prepends an IRI value to the front of a list of the property
	// "dependedBy".
	PrependIRI(v *url.URL)
	// PrependType prepends an arbitrary type value to the front of a list of
	// the property "dependedBy". Invalidates all iterators. Returns an
	// error if the type is not a valid one to set for this property.
	PrependType(t Type) error
	// Remove deletes an element at the specified index from a list of the
	// property "dependedBy", regardless of its type. Panics if the index
	// is out of bounds. Invalidates all iterators.
	Remove(idx int)
	// 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 a Ticket value to be at the specified index for the property
	// "dependedBy". Panics if the index is out of bounds. Invalidates all
	// iterators.
	Set(idx int, v ForgeFedTicket)
	// SetIRI sets an IRI value to be at the specified index for the property
	// "dependedBy". Panics if the index is out of bounds.
	SetIRI(idx int, v *url.URL)
	// SetType sets an arbitrary type value to the specified index of the
	// property "dependedBy". Invalidates all iterators. Returns an error
	// if the type is not a valid one to set for this property. Panics if
	// the index is out of bounds.
	SetType(idx int, t Type) error
	// Swap swaps the location of values at two indices for the "dependedBy"
	// property.
	Swap(i, j int)
}